# SDK ## Android ### v3 -------------------------------------------------------------------------------- title: "概要" description: "Catalyst Android SDKは、Catalystプロジェクト向けのAndroidアプリを構築するためのライブラリです。Catalyst Android SDKパッケージには、強力なバックエンドを備えた動的で堅牢なAndroidアプリの開発を支援する多数のツールと機能が含まれています。" last_updated: "2026-06-10T06:04:54.090Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/overview/" service: "All Services" related: - Mobile Device Management (/ja/cloud-scale/help/mobile-device-management/introduction) - iOS SDK (/ja/sdk/ios/v2/overview/) - Flutter SDK (/ja/sdk/flutter/v2/overview/) - Web SDK (/ja/sdk/web/v4/overview/) -------------------------------------------------------------------------------- # Android SDK ## 概要 Catalyst Android SDKは、Androidプラットフォームにおいて、Catalystプロジェクト向けのモバイルアプリを構築するためのライブラリです。Catalyst Android SDKパッケージには、強力なバックエンドを備えた動的で堅牢なAndroidアプリの開発を支援する多数のツールと機能が含まれています。 Catalyst Android SDKは、Androidアプリの以下の両方の開発プラットフォームをサポートしています： * Kotlin * Java Android SDKパッケージを使用すると、さまざまなCatalystサービスやコンポーネントに関する複数のバックエンド処理を行うことができます。主に、Android SDKにはユーザー認証やリダイレクト、Data StoreおよびFile Storeの機能、関数の実行など、Catalyst Cloud ScaleおよびCatalyst Serverlessの機能に関するツールが含まれています。 Android SDKは、これらのコンポーネントへのAPIリクエストをメソッド呼び出しとしてラップしており、利用可能な状態で提供されます。SDKパッケージが提供するすぐに使える機能を実装することで、これらのCatalystコンポーネントをAndroidアプリにシームレスに統合し、簡単に構築することができます。これにより、バックエンドをゼロからコーディングする時間と労力を節約し、アプリのユーザーエクスペリエンスの設計により集中することができます。 Android SDKドキュメントでは、Catalyst Android SDKを使用してAndroidアプリをセットアップおよび構築するプロセス全体について説明しています。このドキュメントでは、SDKパッケージのアーキテクチャ、コンポーネント、および設定について学び、さまざまな操作のサンプルコードスニペットにアクセスすることができます。 Note: Androidアプリの開発とテストが完了したら、Mobile Device Managementを使用してアプリをホストおよび配布できます。また、Catalystコンソールからアプリのバージョン管理やエンドユーザーの管理を簡単に行うこともできます。ただし、Mobile Device Managementは、EU、AU、IN、またはCAデータセンターからアクセスするCatalystユーザーには現在利用できません。 -------------------------------------------------------------------------------- title: "クラス階層" description: "クラス階層は、Catalyst Android SDKにおけるKotlinクラスの階層構造を表しています。" last_updated: "2026-06-10T06:04:54.091Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/class-hierarchy/" service: "All Services" related: - Authentication (/ja/cloud-scale/help/mobile-device-management/introduction) - Data Store (/ja/cloud-scale/help/data-store/introduction) - File Store (/ja/cloud-scale/help/file-store/introduction) - Search (/ja/cloud-scale/help/search-integration/introduction/) - Functions (/ja/serverless/help/functions/introduction) - ZCQL (/ja/cloud-scale/help/zcql/introduction) -------------------------------------------------------------------------------- # クラス階層 ### はじめに すべてのCatalystコンポーネントは、Android SDKにおいてKotlinクラスとしてモデル化されています。これらのコンポーネントクラスのメンバーとメソッドは、コンポーネントの動作を定義し、コンポーネント内でさまざまな操作を実行することを可能にします。 Catalyst Android SDKパッケージには、さまざまなCatalystサービスの以下のCatalystコンポーネントおよび機能を操作するためのツールが含まれています： * **General:** Timezone * **Serverless:** Functions * **Cloud Scale:** Authentication, Data Store, File Store, Search, ZCQL Catalyst Android SDKコンポーネントクラスの階層構造は、以下のアーキテクチャ図に示されています。 **ZCatalystApp**は、Catalyst Android SDKの基底クラスです。SDKの初期化やCatalystプロジェクトのさまざまなコンポーネントへのアクセスを可能にする複数のメソッドで構成されています。その他のクラスは、SDKがサポートするそれぞれのコンポーネントおよびその固有の機能に対応しています。 <br> ### インスタンスオブジェクト ZCatalystApp配下の各クラスには、API呼び出しを実行して直下の子エンティティのプロパティやデータを取得するための関数が含まれています。 ただし、下位レベルのコンポーネントのデータを取得するために、クラス階層を最上位までたどることが常に効率的であるとは限りません。そのような操作では各レベルでAPI呼び出しが発生し、アプリケーションの使用効率が低下するためです。この状況を回避し、アプリをよりコスト効率の良いものにするために、Catalystはすべてのクラスにインスタンスオブジェクトを提供しています。 **インスタンスオブジェクト**は各コンポーネントクラスに存在し、**getInstance()**メソッドを通じてアクセスできます。このメソッドはコンポーネントのダミーオブジェクトを取得し、そのオブジェクトを使用してすべての子エンティティのメソッドを取得することができます。 したがって、Catalystコンポーネントのプロパティを取得するには、そのコンポーネントのオブジェクトをgetInstance()メソッドで呼び出す必要があります。その後、同じオブジェクトを使用して、コンポーネントで定義されている他のメソッドを呼び出す必要があります。これにより、不要で過剰なAPI呼び出しを防ぐことができます。 -------------------------------------------------------------------------------- title: "例外" description: "このヘルプページでは、Catalyst Androidアプリの実行時に発生する可能性のある一般的な例外について説明します。" last_updated: "2026-06-10T06:04:54.091Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/exceptions/" service: "All Services" related: - Developer Tools (/ja/getting-started/set-up-a-catalyst-project/developer-tools) -------------------------------------------------------------------------------- # 例外 例外とは、アプリの実行中に発生する予期しない不正な動作です。Catalyst Androidアプリにおけるすべてのエラーと例外は、Android SDKパッケージで定義されているZCatalystExceptionという列挙型によって処理されます。 アプリで例外が発生した場合、その例外の以下のプロパティが返されます： * code: エラーの一意識別子 * errorMsg: エラーに関する一般的な説明 * errorDetails: エラーに関する追加情報 * originalException: スローされた実際の例外 Catalyst Android SDKがスローする一般的なエラーコードとその説明を以下に示します： <table class="content-table"> <thead> <tr> <th class="w30p">エラーコード</th> <th class="w70p">説明</th> </tr> </thead> <tbody> <tr> <td><strong>INITIALIZATION_ERROR</strong></td> <td>SDKの初期化に失敗しました</td> </tr> <tr> <td><strong>LOGIN_ERROR</strong></td> <td>ユーザーのログイン処理に失敗しました</td> </tr> <tr> <td><strong>LOGOUT_FAILED</strong></td> <td>ユーザーのログアウト処理に失敗しました</td> </tr> <tr> <td><strong>TOKEN_FETCH_ERROR</strong></td> <td>アクセストークンの取得に失敗しました</td> </tr> <tr> <td><strong>RESPONSE_PARSE_ERROR</strong></td> <td>受信したレスポンスを解析できません</td> </tr> <tr> <td><strong>NO_NETWORK_AVAILABLE</strong></td> <td>API呼び出しを行うためのネットワーク接続が利用できません</td> </tr> <tr> <td><strong>API_FAILED</strong></td> <td>APIの呼び出しに失敗しました</td> </tr> <tr> <td><strong>INVALID_DATA</strong></td> <td>送信されたデータが、指定された形式に対して有効な型ではありません</td> </tr> <tr> <td><strong>FILE_SIZE_EXCEEDED</strong></td> <td>アップロードされたファイルのサイズが100MBの制限を超えています</td> </tr> <tr> <td><strong>FUNCTION_EXECUTION_ERROR</strong></td> <td>関数の実行に失敗しました</td> </tr> <tr> <td><strong>JSON_EXCEPTION</strong></td> <td>リクエストに含まれるボディが有効なJSONではありません</td> </tr> <tr> <td><strong>INVALID_REQUEST</strong></td> <td>作成されたリクエストが有効ではありません</td> </tr> <tr> <td><strong>INVALID_FILE_INPUT</strong></td> <td>アップロード操作で送信されたファイルが有効ではありません</td> </tr> <tr> <td><strong>INTERNAL_ERROR</strong></td> <td>SDKで内部エラーが発生しました</td> </tr> <tr> <td><strong>INVALID_CONFIGURATION</strong></td> <td>ログインに必要な設定でSDKが初期化されていません。適切な設定でSDKを再初期化してください。</td> </tr> <tr> <td><strong>CUSTOM_LOGIN_DISABLED</strong></td> <td>サードパーティ認証に必要なパラメータが見つかりませんでした。プロジェクトでサードパーティ認証が有効になっていることを確認するか、プロパティファイルを再ダウンロードしてください。</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "前提条件" description: "このページでは、Catalyst Android SDKを使用するために満たす必要のある前提条件を定義します。" last_updated: "2026-06-10T06:04:54.091Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/prerequisites/" service: "All Services" related: - Create Catalyst Projects (/ja/getting-started/catalyst-projects) - Developer Tools (/ja/getting-started/set-up-a-catalyst-project/developer-tools) -------------------------------------------------------------------------------- # 前提条件 Catalyst Android SDKの使用を開始する前に、以下のすべての前提条件を満たしていることを確認する必要があります： * モバイルアプリをホストするために、CatalystコンソールでCatalystプロジェクトを作成してください。 Note: 各プロジェクトには、1つのAndroidアプリと1つのiOSアプリをホストできます。AndroidまたはiOSアプリは、Catalyst AndroidまたはiOS SDKを使用してネイティブに構築するか、Catalyst Flutter SDKを使用して構築できます。 * Android StudioでAndroidプロジェクトを作成またはインポートしてください。 * Androidプロジェクトおよび Android Studioが以下の**最低サポート環境**を満たしていることを確認してください： * Android Studio- 3.1.1以降 * OS- Android 21 (Lollipop 4.4) * Kotlin- 1.3.20 * Gradle- 3.4.0 前提条件の環境を設定した後、Catalystにアプリを登録し、アプリ向けにカスタマイズされた設定ファイルをダウンロードできます。この設定ファイルには、アプリが正しく機能するために必要な特定のプロパティの定義が含まれているため、Androidアプリの構造に含める必要があります。 これらの手順については、セットアップセクションで詳しく説明します。 -------------------------------------------------------------------------------- title: "セットアップ" description: "CatalystプロジェクトとAndroidプロジェクトをセットアップするための手順です。" last_updated: "2026-06-10T06:04:54.091Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/setup/" service: "All Services" related: - Environments (/ja/deployment-and-billing/environments/introduction/#introduction) - Developer Tools (/ja/deployment-and-billing/environments/introduction/#introduction) -------------------------------------------------------------------------------- # セットアップ CatalystプロジェクトとAndroidプロジェクトを作成した後、以下の手順に従ってAndroid SDKパッケージをアプリにセットアップおよび統合する必要があります。 ### ステップ 1: CatalystにAndroidアプリを登録する まず、CatalystでAndroidアプリのパッケージを作成して登録し、固有の設定ファイルをダウンロードします。 1. プロジェクトのCatalystコンソールから設定アイコンをクリックします。 2. 設定メニューのProject Settingsの下にある**Developer Tools**に移動し、**Android**タイルをクリックします。 または、下の**Add Package**ボタンをクリックすることもできます。 <br /> 3. 一意に識別するパッケージ名を入力します。アプリへのログイン後にエンドユーザーをリダイレクトするURLを、Redirect URLとして指定します。 ここで入力した値は、設定ファイルに自動入力されます。 Note: パッケージ名はそのOSに一意に関連付けられます。そのため、AndroidアプリとiOSアプリの両方に同じ名前のパッケージを作成することはできません。一意の値を指定する必要があります。 OSタイプとしてAndroidが選択されていることを確認してください。 <br /> 4. **Create**をクリックして、モバイルSDKパッケージを作成します。 5. コンソールに設定ファイルをダウンロードできるウィンドウが表示されます。**Download**をクリックしてファイルをダウンロードします。 必要なすべての設定が含まれたファイルがダウンロードされます。このファイルのプロパティについては、次のステップで説明します。 <br /> ### ステップ 2: Androidプロジェクトに設定ファイルをインポートする Catalystは、アプリケーションの開発とビルドのために2つの作業環境を提供しています：**Development**サンドボックスとライブの**Production**環境です。これらの詳細については、環境のヘルプページをご覧ください。 コンソールでパッケージを作成すると、現在作業している環境に関係なく、最初はDevelopment環境の設定ファイルのみがダウンロード可能になります。パッケージが作成された後は、いつでもコンソールから任意の環境の設定ファイルをダウンロードすることができます。 各環境の設定ファイルの名前は以下のとおりです： * Development: **app_configuration_development.properties** * Production: **app_configuration_production.properties** 作業中の環境に基づいて、適切なファイルをダウンロードしてAndroidアプリの構造に追加する必要があります。Production環境の設定ファイルを取得するには、まずプロジェクトをProductionにデプロイしてから、Developer Tools設定セクションからファイルをダウンロードする必要があります。 設定ファイルは、Androidアプリモジュールの**assets**ディレクトリに追加する必要があります。通常、assetsフォルダはapp/src/mainディレクトリに作成されます。 Androidアプリモジュールの詳細については、Androidの公式ドキュメントを参照してください。 <br /> #### app_configuration_development.properties/ app_configuration_production.propertiesファイルのプロパティ アプリ設定ファイルは、以下の表に記載されているプロパティを定義します。リクエストヘッダーを除くすべての値は、プロジェクトの詳細またはデフォルトの標準に基づいて自動的に入力されます。 Note: これらの値の取得先については、表中に記載されているリンクを参照してください。 <table class="content-table"> <thead> <tr> <th class="w20p">プロパティ</th> <th class="w20p">データ型</th> <th class="w60p">説明</th> </tr> </thead> <tbody> <tr> <td>**clientID**</td> <td>String</td> <td>Catalystに登録されたアプリクライアントの一意識別子です。設定ファイルで提供されます。</td> </tr> <tr> <td>**clientSecret**</td> <td>String</td> <td>特定のclientIDに対して生成されたシークレット値で、APIリクエスト時に渡されます。設定ファイルで提供されます。</td> </tr> <tr> <td>**portalID**</td> <td>String</td> <td>設定ファイルで提供される一意識別子です。</td> </tr> <tr> <td>**redirectUrl**</td> <td>String</td> <td>前のステップでコンソールでパッケージを作成する際に指定した、アプリのコールバックURLです。</td> </tr> <tr> <td>**projectID**</td> <td>Long</td> <td>Catalystプロジェクトの一意のIDです。</td> </tr> <tr> <td>**apiBaseURL**</td> <td>String</td> <td>内部APIが呼び出されるCatalystサーバーのURLです。作業中の環境に基づいて、適切なURL（Development URLまたはProduction URL）を使用する必要があります。</td> </tr> <tr> <td>**oauthScopes**</td> <td>String</td> <td>プロジェクトからCatalyst APIにアクセスするためにアプリが使用するスコープです。利用可能なOAuthスコープはこちらで確認できます。</td> </tr> <tr> <td>**requestHeaders**</td> <td>String</td> <td>HTTPリクエストでクライアントから送信されるヘッダーです。<br /> リクエストヘッダーの値は、個別のキーと値のペアをカンマで区切って指定します：requestHeaders=key1:value1, key2:value2</td> </tr> <tr> <td>**serverTLD**</td> <td>String</td> <td>データサーバーのトップレベルドメインです。<br /> 使用可能な値：**AU**, **CN**, **COM**, **EU** および **IN**</td> </tr> <tr> <td>**printStackTrace**</td> <td>Boolean</td> <td>**printStackTrace**の値が「true」に設定されている場合、ログの詳細なトレースを取得できます。デフォルト値は「false」です。</td> </tr> <tr> <td>**minLogLevel**</td> <td>String</td> <td>アプリのログ設定を行うことができます。<br /> 使用可能な値：**warnings**, **errors**, **information**, **debug**, **ALL**</td> </tr> <tr> <td>**httpRequestMode**</td> <td>String</td> <td>HTTPリクエストが同期か非同期かを定義します。<br /> 使用可能な値：**SYNC**, **ASYNC**<br /> デフォルト値：ASYNC</td> </tr> <tr> <td>**connectTimeOut<br>InSec**</td> <td>Long</td> <td>SDKから送信されるHTTPリクエストの接続タイムアウト値（秒単位）です。<br /> この時間内にサーバーからクライアントリクエストへのレスポンスが受信されない場合、接続は終了します。</td> </tr> <tr> <td>**readTimeOutInSec**</td> <td>Long</td> <td>SDKから送信されるHTTPリクエストの読み取りタイムアウト値（秒単位）です。<br /> この時間内にサーバーからデータが受信されない場合、接続は終了します。</td> </tr> <tr> <td>**writeTimeOutInSec**</td> <td>Long</td> <td>SDKから送信されるHTTPリクエストの書き込みタイムアウト値（秒単位）です。<br /> この時間内にリクエストデータのサーバーへの書き込みまたは送信に失敗した場合、接続は終了します。</td> </tr> <tr> <td>**JWTClientID**</td> <td>String</td> <td>クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントIDプロパティです。</td> </tr> <tr> <td>**JWTClientSecret**</td> <td>String</td> <td>クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントシークレットプロパティです。</td> </tr> </tbody> </table> Note:<br /> * **clientID**、**clientSecret**、**projectID**、または**portalID**の値を設定ファイルで変更すると、SDKおよびAndroidアプリの動作に影響します。これらの設定を変更する場合は、Developer Toolsセクションから必要なプロジェクト用の新しいパッケージを作成し、適切な環境の新しい設定ファイルをダウンロードして、アプリの構造のassetsディレクトリに追加してください。 * ダウンロードした設定ファイルに入力されたプロパティの値は、**ZCatalystApp.configs**オブジェクトを使用して動的にアクセスできます。 <br /> ### ステップ 3: アプリにCatalyst Android SDKを追加する 次のステップは、アプリにSDKパッケージを含めることです。Catalyst Android SDKはGradleライブラリとして利用可能です。ライブラリを含むMavenリポジトリにアクセスすることで、以下の方法でAndroidプロジェクトにSDKを追加できます： 1. Androidアプリ構造の**プロジェクトレベル**の**build.gradle**ファイルに、以下のコードスニペットを追加します： maven { url "https<span></span>://maven.zohodl.com/" } 2. Androidアプリ構造の**アプリレベル**の**build.gradle**ファイルに、以下のコードスニペットを追加します： dependencies { implementation 'com.zoho.catalyst:android-sdk:3.0.1' } <br /> ### ステップ 4: アプリのログインリダイレクトを設定する ユーザーがアプリに正常にログインすると、アプリのホーム画面にリダイレクトされます。このユーザーログインとリダイレクトはCatalyst SDKによって処理されます。 このリダイレクトが正しく処理されるようにするために、Androidアプリのstrings.xmlファイルに以下の文字列を含めてください： &lt;string name="url_scheme"&gt;{redirection_url}&lt;/string&gt; strings.xmlファイルは、Androidプロジェクトを作成した際に自動的に作成されます。アプリの構造でapp/src/main/res/valuesに移動すると見つけることができます。このファイルにはアプリ名の文字列定義がすでに含まれています。その文字列と一緒にこの文字列を含めてください。 このコードのredirection_urlの部分には、Catalystでアプリのパッケージを作成する際に設定した**リダイレクトURL**を渡す必要があります。 <br /> ### ステップ 5: 必要な権限を設定する Catalyst SDKでは、アプリがシームレスに機能し、スムーズなユーザーエクスペリエンスを提供するために、以下のアプリ権限を有効にする必要があります： * **INTERNET**: Catalyst APIを実行するため * **ACCESS_NETWORK_STATE**: ネットワーク障害を処理するため これらの権限を有効にするには、以下のように**AndroidManifest.xml**ファイルで宣言する必要があります： &lt;uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/&gt; &lt;uses-permission android:name="android.permission.INTERNET"/&gt; AndroidManifest.xmlファイルは、アプリの構造でapp/src/mainに移動すると見つけることができます。 Catalyst Android SDKを追加および実装するために必要なすべての設定が完了しました。上記のすべてのステップを実行した後、**プロジェクトをビルド**する必要があります。Gradleビルドが成功すると、アプリはCatalyst Android SDKのコンポーネントにアクセスできるようになります。 <br /> ### ステップ 6: SDKを初期化する SDKパッケージで定義されているメソッドと機能を有効にするには、Catalyst SDKを初期化する必要があります。 したがって、SDKメソッドを使用するようにアプリを設定する前に、以下のいずれかの方法でSDKを初期化する必要があります： #### 方法 1: 環境を指定する **Environment**は、アプリがDevelopment環境またはProduction環境のどちらで動作しているかを示します。環境に基づいてアプリのプロジェクトに適切な設定ファイル（app_configuration_development.properties/ app_configuration_production.properties）を含めるのと同様に、適切な環境用にSDKを初期化する必要があります。 この方法では、必要な設定を行い、アプリのEnvironmentを**DEVELOPMENT**または**PRODUCTION**として指定し、以下のようにZCatalystAppクラスを通じてinit()メソッドに渡します： ZCatalystApp.init( context: Context, Environment: ZCatalystSDKConfigs.Environment.{DEVELOPMENT} ): ZCatalystApp <br /> #### 方法 2: 環境を指定しない SDK初期化時にEnvironmentが指定されていない場合、デフォルトで**PRODUCTION**とみなされます。したがって、アプリがProduction環境で動作している場合は、以下のようにEnvironmentを指定せずに直接SDKを初期化できます： ZCatalystApp.init(context: Context): ZCatalystApp <br /> Note: * app_configuration_development.propertiesまたはapp_configuration_production.propertiesファイルに変更を加えた場合は、SDKを再初期化する必要があります。 * Androidアプリにサードパーティ認証を設定した場合、この設定ファイルに新しいプロパティが追加されるため、SDKの再初期化も必要になります。詳細はこちらのヘルプページをご覧ください。 SDKが正常に初期化されると、アプリはコンポーネントメソッドを呼び出し、意図したとおりに動作します。 #### Cloud Scale ##### Data Store -------------------------------------------------------------------------------- title: "新しいData Storeインスタンスの作成" description: "Catalyst Data Storeは、アプリケーションの永続データをテーブル形式で格納するクラウドベースのリレーショナルデータベース管理システムです。" last_updated: "2026-06-10T06:04:54.092Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/data-store/create-data-store-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Data Store - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # Data Store Catalyst Data Storeは、アプリケーションの永続データをテーブルを通じて格納するクラウドベースのリレーショナルデータベース管理システムです。 ### 新しいData Storeインスタンスの作成 CatalystプロジェクトのData Storeにアクセスするには、Data Storeのインスタンスを作成し、このクラスで定義されているメソッドを有効にしてインスタンスオブジェクトにアクセスすることができます。これにより、不要なサーバー呼び出しを防ぐことができます。 Data Storeインスタンスを正常に取得するには、以下のコード構文に示すように**getDataStoreInstance()**メソッドを呼び出す必要があります： ZCatalystApp.getInstance().getDataStoreInstance(): ZCatalystDataStore -------------------------------------------------------------------------------- title: "新しいテーブルインスタンスの作成" description: "Data Store内の特定のテーブルのテーブルインスタンスを作成し、このクラスで定義されているメソッドを有効にしてインスタンスオブジェクトにアクセスできます。" last_updated: "2026-06-10T06:04:54.092Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/data-store/create-table-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Tables (/ja/cloud-scale/help/data-store/tables) - Data Store - API (/ja/api/code-reference/cloud-scale/data-store/insert-new-row/#InsertNewRow) -------------------------------------------------------------------------------- # 新しいテーブルインスタンスの作成 Data Store内の特定のテーブルのテーブルインスタンスを作成し、このクラスで定義されているメソッドを有効にしてインスタンスオブジェクトにアクセスできます。これにより、不要なサーバー呼び出しを防ぐことができます。 テーブルインスタンスは、以下の2つの方法のいずれかで**getTableInstance()**メソッドを呼び出すことで作成できます。 両方の方法で使用する&lt;DATA_STORE_INSTANCE&gt;は、Data Storeインスタンスページで定義されているインスタンスです。 ### IDによるテーブルインスタンスの作成 以下のコード構文に示すように、特定のテーブルIDを引数としてgetTableInstance()メソッドに渡すことで、テーブルインスタンスを作成できます： &lt;DATA_STORE_INSTANCE&gt;.getTableInstance( id: Long ): ZCatalystTable **パラメータ**: * **id**: インスタンスを作成する必要がある特定のテーブルの一意のテーブルID 以下にサンプルコードスニペットを示します： val table = ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance(2823000000017011) //これをあなたのテーブルIDに置き換えてください ### 名前によるテーブルインスタンスの作成 また、以下のコード構文に示すように、特定のテーブル名を引数として**getTableInstance()**メソッドに渡すことで、テーブルインスタンスを作成することもできます： &lt;DATA_STORE_INSTANCE&gt;.getTableInstance( identifier: String ): ZCatalystTable **パラメータ**: * **identifier**: インスタンスを作成する必要がある特定のテーブルの名前 以下にサンプルコードスニペットを示します： val table = ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails") //これをあなたのテーブル名に置き換えてください -------------------------------------------------------------------------------- title: "カラムメタデータの取得" description: "指定したインスタンスのData Storeテーブルの全カラムまたは特定のカラムのメタデータをIDまたは名前で取得できます。" last_updated: "2026-06-10T06:04:54.092Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/data-store/get-column-metadata/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Columns (/ja/cloud-scale/help/data-store/columns) - Get Metadata of Coulumns - API (/ja/api/code-reference/cloud-scale/data-store/get-all-columns-metadata/#GetAllColumnsMetadata) -------------------------------------------------------------------------------- # カラムメタデータの取得 ### 特定のカラムのメタデータの取得 **getColumn()**メソッドを呼び出すことで、指定したインスタンスのData Storeテーブルの特定のカラムのメタデータを取得できます。操作が成功した場合、このメソッドはカラムのデータ型、デフォルト値、最大長、読み取り専用、一意、必須かどうかなどのメタデータを返すことができます。 特定のカラムのメタデータは2つの方法で取得できます。両方の方法で使用する&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されているインスタンスです。 #### i. IDによるカラムの取得 以下のコード構文に示すように、カラムIDを引数としてgetColumn()メソッドに渡すことで、特定のカラムのメタデータを取得できます： &lt;TABLE_INSTANCE&gt;.getColumn( id: Long, success: (ZCatalystColumn) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ZCatalystColumn&gt;&gt;? **パラメータ**: * **id**: 取得する必要がある特定のカラムの一意のカラムID 以下にサンプルコードスニペットを示します： val table = ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails") //これをあなたのテーブル名に置き換えてください table.getColumn(2823000000017733, //ここにカラムIDを入力してください { column -> println("Get Column success") println("The name of the column is: ${column.name}") }, { exception -> println("Get column failed! $exception") }) #### ii. 名前によるカラムの取得 以下のコード構文に示すように、カラム名を引数としてgetColumn()メソッドに渡すことで、特定のカラムのメタデータを取得できます： &lt;TABLE_INSTANCE&gt;.getColumn( name: String, success: (ZCatalystColumn) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ZCatalystColumn&gt;&gt;? **パラメータ**: * **name**: 取得する必要がある特定のカラムの名前 以下にサンプルコードスニペットを示します： val table = ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails") //これをあなたのテーブル名に置き換えてください table.getColumn("DepartmentName", //これをあなたの列名に置き換えてください { column -> println("Get Column Success") println("The ID of the column is: ${column.id}") }, { exception -> println("Get column failed! $exception") }) ### 全カラムのメタデータの取得 以下のコード構文に示すように、**getColumns()**メソッドを使用して、指定したインスタンスのテーブルの全カラムのメタデータを取得できます。操作が成功した場合、このメソッドは特定のテーブルの全カラムのメタデータを返すことができます。 以下のコードで使用する&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されているインスタンスです。 &lt;TABLE_INSTANCE&gt;.getColumns( success: (List&lt;ZCatalystColumn&gt;) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ArrayList&lt;ZCatalystColumn&gt;&gt;&gt;? 以下にサンプルコードスニペットを示します： val table = ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails") //これをあなたのテーブル名に置き換えてください table.getColumns( { columns -> println("Get Columns success") for (column in columns) { println("${column.name}") } }, { exception -> println("Get Columns failed! $exception.") } ) -------------------------------------------------------------------------------- title: "行の取得" description: "指定したインスタンスのData Storeテーブルから、特定の行や全行をページネーションを使用して取得できます。" last_updated: "2026-06-10T06:04:54.097Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/data-store/get-rows/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Get All Rows - API (/ja/api/code-reference/cloud-scale/data-store/get-all-rows/#GetAllRows) -------------------------------------------------------------------------------- # 行の取得 ### 特定の行の取得 **getRow()**メソッドを使用して、指定したインスタンスのData Storeテーブルから特定の行を取得できます。以下のコード構文に示すように、行の一意のROWIDを引数としてこのメソッドに渡します。 以下のコードで使用する&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されているインスタンスです。 &lt;TABLE_INSTANCE&gt;.getRow( id: Long, success: (ZCatalystRow) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ZCatalystRow&gt;&gt;? **パラメータ**: * **id**: 取得する必要がある特定の行の一意のROWID 以下にサンプルコードスニペットを示します： val table = ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails") //これをあなたのテーブル名に置き換えてください table.getRow(2823000000014176, //ここに行IDを入力してください { row -> println("Get Row Success") println(" The row details are: ${row.getData()}") }, { exception -> println("Get row failed! $exception") }) <br> ### ページネーションによる行の取得 コードにページネーションを組み込むことで、Data Storeのテーブルから全行を取得できます。ページネーションにより、テーブルの行をイテレーションを通じてバッチまたはページ単位で取得できます。 たとえば、行を100件ずつのバッチで個別のページとして取得する場合、各ページで取得する最大行数を定義し、以下のように**maxRows**を使用してカウントを指定できます。 以下のコードスニペットで使用する&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されているインスタンスです。 &lt;TABLE_INSTANCE&gt;.getRows(maxRows: Int, success: (List&lt;ZCatalystRow&gt;, ResponseInfo) -> Unit, failure: ((ZCatalystException) -&gt; Unit)? = null): ZCatalystRequest&lt;ZCatalystResponse&lt;ArrayList&lt;ZCatalystRow&gt;&gt;&gt;? **パラメータ**: * **maxRows**: このイテレーションで取得する最大行数 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails").getRows( 10, { rows, info -&gt;{ println("The token for next set of rows - ${info.nextToken}") println("Boolean to know if there are records in next page - ${info.moreRecords}") } }, { exception -&gt; println("Failed to get the rows! $exception") }) さらに、ループの各実行後に、後続のデータ取得を許可するトークン文字列がレスポンスで返されます。このトークンはinfo.nextTokenを通じて取得でき、後続のイテレーションでnextTokenの値として渡します。ループの最初の実行時には、nextToken文字列は渡しません。 コードスニペットに示すように、info.moreRecordsを通じて取得待ちの行数を確認することもできます。 ページネーションを続行する場合は、nextTokenとmaxRowsを渡して次の行セットを取得できます。以下のように行います。 &lt;TABLE_INSTANCE&gt;.getRows(nextToken: String, maxRows: Int, success: (List&lt;ZCatalystRow&gt;, ResponseInfo) -> Unit, failure: ((ZCatalystException) -&gt; Unit)? = null): ZCatalystRequest&lt;ZCatalystResponse&lt;ArrayList&lt;ZCatalystRow&gt;&gt;&gt;? **パラメータ**: * **maxRows**: このイテレーションで取得する最大行数 * **nextToken**: 次の行セットを取得するための認可トークン 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails").getRows( "1000.6f********" , 20 , { rows, info ->{ println("The token for next set of rows - ${info.nextToken}") println("Boolean to know if there are records in next page - ${info.moreRecords}") } }, { exception -> println("Failed to get the rows! $exception") }) info.moreRecordsがFALSEを返すまで、nextTokenとmoreRecordsの情報を取得できます。 最初のイテレーション後に残りの全行を取得し、maxRowsの制限を設定しない場合は、以下の方法で行うことができます： &lt;TABLE_INSTANCE&gt;.getRows(nextToken: String, success: (List&lt;ZCatalystRow&gt;, ResponseInfo) -&gt; Unit, failure: ((ZCatalystException) -&gt; Unit)? = null): ZCatalystRequest&lt;ZCatalystResponse&lt;ArrayList&lt;ZCatalystRow&gt;&gt;&gt;? **パラメータ**: * **nextToken**: 次の行セットを取得するための認可トークン 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails").getRows( "1000.6f********", { rows, info ->{ println("The token for next set of rows - ${info.nextToken}") println("Boolean to know if there are records in next page - ${info.moreRecords}") } }, { exception -> println("Failed to get the rows! $exception") }) これにより、info.moreRecordsはFALSEを返します。 <br> ### 全行の取得 以下のコード構文に示すように、**getRows()**メソッドを使用して、指定したインスタンスのテーブルの全行を取得できます。操作が成功した場合、このメソッドはフィルターや条件なしでテーブルの全行を返します。 以下のコード構文で使用する&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されているインスタンスです。 &lt;TABLE_INSTANCE&gt;.getRows( success: (List&lt;ZCatalystRow&gt;,ResponseInfo) → Unit, failure: ((ZCatalystException) → Unit)?= null): ): ZCatalystRequest&lt;ZCatalystResponse&lt;ArrayList&lt;ZCatalystRow&gt;&gt;&gt;? 以下にサンプルコードスニペットを示します： val table = ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails") //これをあなたのテーブル名に置き換えてください table.getRows( { rows, info ->{ println("The token for next set of rows - ${info.nextToken}") println("Boolean to know if there are records in next page - ${info.moreRecords}") } }, { exception -> println("Failed to get the rows! $exception") }) Note: これは全行を取得する操作のため、info.nextTokenは無視できます。ページネーションなしで利用可能な全行が返されます。全行が取得された場合、info.moreRecordsもFALSEを返します。 -------------------------------------------------------------------------------- title: "行からカラム値を取得" description: "Data Storeテーブルの行から特定のカラムの値を取得できます。" last_updated: "2026-06-10T06:04:54.098Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/data-store/get-column-value-from-row/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Columns (/ja/cloud-scale/help/data-store/columns) - Get Metadata of Columns - API (/ja/api/code-reference/cloud-scale/data-store/get-all-columns-metadata/#GetAllColumnsMetadata) -------------------------------------------------------------------------------- # 行からカラム値を取得 getFieldValue()メソッドを使用して、Data Storeテーブルの行から特定のカラムの値を取得できます。たとえば、行内の「Employee ID」という単一のカラムの値が必要な場合、このメソッドを使用してその特定の値を取得できます。 以下のコード構文に示すように、カラムのフィールド名を引数としてgetFieldValue()メソッドに渡す必要があります。 以下のコードで使用する&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されているインスタンスです。 &lt;TABLE_INSTANCE&gt;.getRow( id : Long, success: (ZCatalystRow) → ZCatalystRow.getFieldValue(fieldAPIName: String): Any, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ZCatalystRow&gt;&gt;? **パラメータ**: * **id**: 取得する必要がある特定の行の一意のROWID * **fieldAPIName**: 値を取得する必要があるカラムの名前 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails").getRow(2823000000054062, // これをあなたのテーブル名に置き換えてください and the ROWID of the row { row -> println(" The value of 'Employee ID' field is :${row.getFieldValue("EmployeeID")}") //これをあなたの列名に置き換えてください }, { exception -> println("Failed to get the column value! $exception") }) -------------------------------------------------------------------------------- title: "新しい行インスタンスの作成" description: "Data Store内の特定のテーブルに対して新しい行インスタンスを作成できます。" last_updated: "2026-06-10T06:04:54.098Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/data-store/create-row-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Insert Row - API (/ja/api/code-reference/cloud-scale/data-store/insert-new-row/#InsertNewRow) -------------------------------------------------------------------------------- # 新しい行インスタンスの作成 Data Store内の特定のテーブルに対して新しい行インスタンスを作成し、このクラスで定義されているメソッドを有効にしてインスタンスオブジェクトにアクセスできます。これにより、不要なサーバー呼び出しを防ぐことができます。 行インスタンスは、以下のコード構文に示すように**newRow()**メソッドを呼び出すことで作成できます。 ここで使用する&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されているインスタンスです。 <br /> &lt;TABLE_INSTANCE&gt;.newRow(): ZCatalystRow <br /> 以下にサンプルコードスニペットを示します： <br /> val rowInstance = ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails").newRow() //これをあなたのテーブル名に置き換えてください -------------------------------------------------------------------------------- title: "行の作成" description: "Data Store内の特定のテーブルに対して新しい行インスタンスを作成し、このクラスで定義されているメソッドを有効にしてインスタンスオブジェクトにアクセスできます。" last_updated: "2026-06-10T06:04:54.098Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/data-store/create-rows/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Insert Row - API (/ja/api/code-reference/cloud-scale/data-store/insert-new-row/#InsertNewRow) -------------------------------------------------------------------------------- # 行の作成 ### 単一行の作成 **newRow()**メソッドを使用して、指定したインスタンスのData Storeテーブルに新しい行を作成できます。カラム名と対応する行の値をキーと値のペアとして指定して、テーブルの行の値を設定する必要があります。 以下のコード構文で使用する&lt;ROW_INSTANCE&gt;は、行インスタンスページで定義されているインスタンスです。 &lt;ROW_INSTANCE&gt;.create( success: (ZCatalystRow) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ArrayList&lt;ZCatalystRow&gt;&gt;&gt;? Note: カラムがis_uniqueまたはis_mandatoryプロパティを有効にして作成された場合、それぞれ値が一意であること、または必須で渡されることを確認する必要があります。また、カラムに渡すデータがカラムに設定されたデータ型であることも確認する必要があります。 以下にサンプルコードスニペットを示します： val row = ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails").newRow() //これをあなたのテーブル名に置き換えてください row.setColumnValue("Department_Name", "Marketing") //これをあなたの列名に置き換えてください and its value row.setColumnValue("Employee_ID", "109223") //これをあなたの列名に置き換えてください and its value row.setColumnValue("Employee_Name", "Robert Smith") //これをあなたの列名に置き換えてください and its value row.create( { success -> println("New row created successfully $success") }, { exception -> println("Failed to create a new row! $exception") } ) ### 複数行の作成 Catalyst Android SDKでは、指定したインスタンスのテーブルに一度に複数の行を作成できます。テーブルに挿入する必要がある行を含む配列を渡すことで実行します。配列は、以下のコード構文に示すように**createRows()**メソッドの引数として渡します。 以下のコードで使用する&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されているインスタンスです。 &lt;TABLE_INSTANCE&gt;.createRows( rows: ArrayList&lt;ZCatalystRow&gt;, success: (List&lt;ZCatalystRow&gt;) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ArrayList&lt;ZCatalystRow&gt;&gt;&gt;? **パラメータ**: * **rows**: 作成する行の配列 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails").createRows( //これをあなたのテーブル名に置き換えてください rowsList, //カラムの名前と値を設定してarrayListに追加する { rows -> println("The IDs of the rows that were successfully created are listed below:") for (row in rows){ println("${row.id}") } }, { exception -> println("Add Rows Failed! $exception") }) -------------------------------------------------------------------------------- title: "行の更新" description: "Data Storeテーブルの特定の行または全行を更新できます。" last_updated: "2026-06-10T06:04:54.098Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/data-store/update-rows/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Rows (/ja/cloud-scale/help/data-store/records) - Update Row - API (/ja/api/code-reference/cloud-scale/data-store/update-row/#UpdateRow) -------------------------------------------------------------------------------- # 行の更新 ### 特定の行の更新 **update()**メソッドを使用して、Data Storeテーブルの特定の行を更新できます。これにより、カラムの変更された値をキーと値のペアとして渡すことで、行の1つ以上のカラムの値を更新できます。 以下のコード構文で使用する&lt;ROW_INSTANCE&gt;は、行インスタンスページで定義されているインスタンスです。 &lt;ROW_INSTANCE&gt;.update( success: (ZCatalystRow) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ArrayList&lt;ZCatalystRow&gt;&gt;&gt;? 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails").getRow(2823000000095003, //これをあなたのテーブル名に置き換えてください and the ROWID of the row { row -> row.setColumnValue("Employee_Name", "Morgan Jones") row.update( { success -> println("Row updated successfully $success") }, { exception -> println("Failed to update the row $exception") } ) }) ### 全行の更新 行の配列を引数として**updateRows()**メソッドに渡すことで、テーブル内の複数の行を更新できます。これにより、カラムの変更された値をキーと値のペアとして渡すことで、行の1つ以上のカラムの値を更新できます。 以下のコードで使用する&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されているインスタンスです。 &lt;TABLE_INSTANCE&gt;.updateRows( rows: ArrayList&lt;ZCatalystRow&gt;, success: (List&lt;ZCatalystRow&gt;) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ArrayList&lt;ZCatalystRow&gt;&gt;&gt;? **パラメータ**: * **rows**: 更新する行の配列 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails").updateRows( //これをあなたのテーブル名に置き換えてください rowsList, //カラムの名前と値を設定してarrayListに追加する { println(">>>> Rows updated successfully $it") }, { println(">>>> Update Rows Failed $it") }) -------------------------------------------------------------------------------- title: "行の削除" description: "Catalyst Android SDKを使用して、特定のData Storeテーブルから単一の行を削除できます。" last_updated: "2026-06-10T06:04:54.098Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/data-store/delete-row/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Delete Row - API (/ja/api/code-reference/cloud-scale/data-store/delete-row/#DeleteRow) -------------------------------------------------------------------------------- # 行の削除 Catalyst Android SDKを使用して、特定のData Storeテーブルから単一の行を削除できます。ただし、一度に複数の行を削除することはできません。 テーブルから行を削除するには、以下の2つの方法のいずれかを使用できます： ### テーブルインスタンスに行IDを渡して行を削除する 以下のコード構文に示すように、行のROWIDを引数として**deleteRow()**メソッドに渡すことで、テーブルから行を削除できます。 以下のコード構文で使用する&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されているインスタンスです。 &lt;TABLE_INSTANCE&gt;.deleteRow( rowId: Long, success: () → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;Unit&gt;? **パラメータ**: * **rowId**: 削除する行の一意のROWID 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("Project").deleteRow(2823000000098007, //これをあなたのテーブル名に置き換えてください and the ROWID of the row { println("Row deleted successfully $it") }, { exception -> println("Delete Row failed $exception") }) ### 行インスタンスを渡して行を削除する 行インスタンスに対して**delete()**メソッドを呼び出すだけで、テーブルから行を削除できます。 以下のコード構文で使用する&lt;ROW_INSTANCE&gt;は、行インスタンスページで定義されているインスタンスです。 &lt;ROW_INSTANCE&gt;.delete( success: () → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;Unit&gt;? 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("EmployeeDetails").getRow(2823000000095003, //これをあなたのテーブル名に置き換えてください and the ROWID of the row { row -> row.delete( { println("Row deleted successfully") }, { exception -> println("Delete row failed $exception") } )}, { exception -> println("Exception occured $exception") }) ##### File Store -------------------------------------------------------------------------------- title: "File Storeインスタンスの作成" description: "Catalyst File Storeは、Catalystアプリケーションのアプリデータファイルおよびユーザーデータファイルのストレージソリューションを提供し、共有データへのアクセスを可能にします。" last_updated: "2026-06-10T06:04:54.098Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/file-store/create-file-store-instance/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - File Store - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder) -------------------------------------------------------------------------------- # File Store Catalyst File Storeは、Catalystアプリケーションのアプリケーションファイルおよびユーザーデータファイルのクラウドストレージソリューションを提供し、共有データへのアクセスを可能にします。画像、動画、テキストファイル、ドキュメントファイル、スプレッドシート、その他の形式のファイルを保存、管理、整理することができます。 ### File Storeインスタンスの作成 **getFileStoreInstance()**メソッドを使用して、CatalystプロジェクトのFile Storeのインスタンスを作成し、このクラスで定義されているメソッドを有効にしてインスタンスオブジェクトにアクセスできます。これにより、不要なサーバー呼び出しを防ぐことができます。 File Storeインスタンスは以下のように作成できます： ZCatalystApp.getInstance().getFileStoreInstance(): ZCatalystFileStore -------------------------------------------------------------------------------- title: "フォルダの取得" description: "File Store内の特定のフォルダの詳細を取得できます。" last_updated: "2026-06-10T06:04:54.098Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/file-store/get-folders/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Get Folder - API (/ja/api/code-reference/cloud-scale/file-store/get-all-folders/#GetAllFolders) -------------------------------------------------------------------------------- # フォルダの取得 ### 特定のフォルダのメタデータの取得 以下のコード構文に示すように、一意のフォルダIDを引数として**getFolder()**メソッドに渡すことで、File Store内の特定のフォルダの詳細を取得できます。これにより、フォルダオブジェクトが取得され、作成日、最終更新日、およびフォルダ内のファイルのメタ情報などのフォルダのメタデータを取得できます。 以下のコードで使用する&lt;FILE_STORE_INSTANCE&gt;は、File Storeインスタンスページで定義されているインスタンスです。 &lt;FILE_STORE_INSTANCE&gt;.getFolder( id: Long, success: (ZCatalystFolder) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ZCatalystFolder&gt;&gt;? **パラメータ**: * **id**: 取得するフォルダの一意のフォルダID 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getFileStoreInstance().getFolder(2823000000006561,//これをあなたのフォルダIDに置き換えてください { folder -> println("Get Folder Success") println("Folder name: ${folder.name} ") }, { exception -> println("Get Folder Failed! $exception") }) ### 全フォルダのメタデータの取得 以下のコード構文に示すように、**getFolders()**メソッドを使用して、プロジェクトのFile Storeで利用可能な全フォルダの詳細を取得できます。これにより、全フォルダおよびフォルダ内のファイルのメタデータを取得できます。 以下のコードで使用する&lt;FILE_STORE_INSTANCE&gt;は、File Storeインスタンスページで定義されているインスタンスです。 &lt;FILE_STORE_INSTANCE&gt;.getFolders( success: (List&lt;ZCatalystFolder&gt;) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ArrayList&lt;ZCatalystFolder&gt;&gt;&gt;? 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getFileStoreInstance().getFolders( { folders -> for (folder in folders){ println("Folder names: ${folder.name}") } }, { exception -> println("Get Folders Failed! $exception") } ) -------------------------------------------------------------------------------- title: "フォルダーインスタンスの作成" description: "File Store内の特定のフォルダーのインスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。" last_updated: "2026-06-10T06:04:54.098Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/file-store/create-folder-instance/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - File Store - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder) -------------------------------------------------------------------------------- # フォルダーインスタンスの作成 **getFolderInstance()** メソッドを使用して、File Store内の特定のフォルダーのインスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。以下のコード構文に示すように、そのフォルダーのフォルダーIDをgetFolderInstance()メソッドに渡す必要があります。 以下のコードで使用されている&lt;FILE_STORE_INSTANCE&gt;は、File Storeインスタンスページで定義されたインスタンスです。 &lt;FILE_STORE_INSTANCE&gt;.getFolderInstance( id: Long ): ZCatalystFolder **パラメータ**: * **id**: インスタンスオブジェクトを返す対象のフォルダーの一意のフォルダーID 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561) //これをあなたのフォルダIDに置き換えてください -------------------------------------------------------------------------------- title: "ファイルの取得" description: "File Store内の特定のファイルまたはすべてのファイルの詳細を取得できます。" last_updated: "2026-06-10T06:04:54.098Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/file-store/get-files/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Get File - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-file/#GetSpecificFile) -------------------------------------------------------------------------------- # ファイルの取得 ### 特定のファイルのメタデータの取得 以下のコード構文に示すように、一意のファイルIDを引数として**getFile()**メソッドに渡すことで、File Store内の特定のファイルの詳細を取得できます。これにより、ファイルオブジェクトが取得され、作成日時、最終更新日時、ファイルサイズなどのファイルのメタデータを取得できます。 以下のコードで使用されている&lt;FILE_STORE_INSTANCE&gt;は、File Storeインスタンスページで定義されたインスタンスです。 &lt;FOLDER_INSTANCE&gt;.getFile( id: Long, success: (ZCatalystFile) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ZCatalystFile&gt;&gt;? **パラメータ**: * **id**: 一意のファイルID 以下にサンプルコードスニペットを示します： val folder = ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561) //これをあなたのフォルダIDに置き換えてください folder.getFile(2823000000044005, //ここにファイルIDを入力してください { file -> println("Get File Success") println("The name of the file is: ${file.name}") println("The size of the file is: ${file.size}") }, { exception -> println("Get File Failed! $exception") }) ### すべてのファイルのメタデータの取得 以下のコード構文に示すように、**getFiles()**メソッドを使用して、特定のフォルダー内のすべてのファイルの詳細を取得できます。 以下のコードで使用されている&lt;FOLDER_INSTANCE&gt;は、フォルダーインスタンスページで定義されたインスタンスです。 &lt;FOLDER_INSTANCE&gt;.getFiles( success: (List&lt;ZCatalystFile&gt;) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ArrayList&lt;ZCatalystFile&gt;&gt;&gt;? 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).getFiles( //これをあなたのフォルダIDに置き換えてください { files -> println("Get Files Success") for (file in files){ println("File names: ${file.name}") } }, { exception -> println("Get Files Failed $exception") } ) -------------------------------------------------------------------------------- title: "ファイルのアップロード" description: "File Store内の既存のフォルダーにファイルをアップロードできます。" last_updated: "2026-06-10T06:04:54.099Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/file-store/upload-file/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Upload File - API (/ja/api/code-reference/cloud-scale/file-store/upload-file-in-folder/#UploadFileInaFolder) -------------------------------------------------------------------------------- # ファイルのアップロード **uploadFile()**メソッドを呼び出すことで、File Store内の既存のフォルダーにファイルをアップロードできます。ファイルがフォルダーにアップロードされると、一意のファイルIDが生成されます。画像、テキストドキュメント、CSV、またはその他のファイルタイプを最大100MBのファイルサイズまでアップロードできます。 以下で説明する5つの方法のいずれかでファイルをアップロードできます。以下のすべてのメソッドのコードセクションで使用されている&lt;FOLDER_INSTANCE&gt;は、フォルダーインスタンスページで定義されたインスタンスです。これは、ファイルをアップロードするフォルダーを参照します。 ### ファイルURIスキームを渡す方法 ファイルのURIスキームを引数としてuploadFile()メソッドに渡すことで、指定したフォルダーインスタンスのフォルダーにファイルをアップロードできます： &lt;FOLDER_INSTANCE&gt;.uploadFile( uri: Uri, success: (ZCatalystFile) → Unit, failure: ((ZCatalystException) → Unit)?, progress: ((Long, Long, Double) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ZCatalystFile&gt;&gt;? **パラメータ**: * **uri**: アップロードするファイルのファイルURIスキーム 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).uploadFile("/src.example.com/files/productImage.png", { println(" >> File Upload Success -$it") }, { println(" >> File Upload Failed -$it") }) ### ファイルパスを渡す方法 ローカルシステムのファイルパスを引数としてuploadFile()メソッドに渡すことで、指定したフォルダーインスタンスのフォルダーにファイルをアップロードできます： &lt;FOLDER_INSTANCE&gt;.uploadFile( filePath: String, success: (ZCatalystFile) → Unit, failure: ((ZCatalystException) → Unit)?, progress: ((Long, Long, Double) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ZCatalystFile&gt;&gt;? **パラメータ**: * **filepath**: アップロードするファイルのファイルパス 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).uploadFile("/Desktop/HelplineCard.jpg", { println(" &gt;&gt; File Upload Success -$it") }, { println(" &gt;&gt; File Upload Failed -$it") }) ### ファイルURIスキームとファイル名を渡す方法 ファイルURIスキームとファイル名の両方を個別の引数としてuploadFile()メソッドに渡すことで、指定したフォルダーインスタンスのフォルダーにファイルをアップロードできます： &lt;FOLDER_INSTANCE&gt;.uploadFile( uri: Uri, fileName: String, success: (ZCatalystFile) → Unit, failure: ((ZCatalystException) → Unit)?, progress: ((Long, Long, Double) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ZCatalystFile&gt;&gt;? **パラメータ**: * **uri**: アップロードするファイルのファイルURIスキーム * **fileName**: アップロードするファイルの名前 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).uploadFile("/src.example.com/files", "productImage.png", { println(" &gt;&gt; File Upload Success -$it") }, { println(" &gt;&gt; File Upload Failed -$it") }) ### ファイルパスとファイル名を渡す方法 ローカルシステムのファイルパスとファイル名の両方を引数としてuploadFile()メソッドに渡すことで、指定したフォルダーインスタンスのフォルダーにファイルをアップロードできます： &lt;FOLDER_INSTANCE&gt;.uploadFile( filePath: String, fileName: String, success: (ZCatalystFile) → Unit, failure: ((ZCatalystException) → Unit)?, progress: ((Long, Long, Double) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ZCatalystFile&gt;&gt;? **パラメータ**: * **filepath**: アップロードするファイルのファイルパス * **fileName**: アップロードするファイルの名前 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).uploadFile("/Desktop", "HelplineCard.jpg", { println(" &gt;&gt; File Upload Success -$it") }, { println(" &gt;&gt; File Upload Failed -$it") }) ### inputStreamとファイル名でファイルを渡す方法 inputStreamとしてのファイルとファイル名の両方を引数としてuploadFile()メソッドに渡すことで、指定したフォルダーインスタンスのフォルダーにファイルをアップロードできます： &lt;FOLDER_INSTANCE&gt;.uploadFile(stream: InputStream, fileName: String, success: (ZCatalystFile) -> Unit, failure: ((ZCatalystException) -> Unit)? = null, progress: ((bytesWritten: Long, contentLength: Long, percentage: Double) -> Unit)? = null) : ZCatalystRequest&lt;ZCatalystResponse&lt;ZCatalystFile&gt;&gt;? **パラメータ**: * **stream**: ファイルのinputStream * **fileName**: アップロードするファイルの名前 以下にサンプルコードスニペットを示します： val file = File("/Desktop/HelplineCard.jpg") val inputStream: InputStream = FileInputStream(file) ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).uploadFile(inputStream, { println(" >> File Upload Success -$it") }, { println(" >> File Upload Failed -$it") }) -------------------------------------------------------------------------------- title: "ファイルのダウンロード" description: "File Store内の既存のフォルダーからファイルをダウンロードできます。" last_updated: "2026-06-10T06:04:54.099Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/file-store/download-file/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Download File - API (/ja/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder) -------------------------------------------------------------------------------- # ファイルのダウンロード **download()**メソッドを呼び出すことで、File Store内の既存のフォルダーからファイルをダウンロードできます。この操作は、ファイルが保存されている一時URLを返します。 以下のコードで使用されている&lt;FILE_INSTANCE&gt;は、サンプルコードスニペットに示すように、特定のファイルに対して作成されたインスタンスです。これは、一意のファイルIDによってダウンロードする必要がある特定のフォルダーからのファイルを参照します。 &lt;FILE_INSTANCE&gt;.download( success: (InputStream) → Unit, failure: ((ZCatalystException) → Unit)?, progress: ((Long, Long, Double) → Unit)? ): ZCatalystRequest&lt;ResponseBody&gt;? 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006561).getFile(2823000000044005, //これをあなたのフォルダIDに置き換えてください and File ID { file -> file.download( { println("File download success ${it.available()}") }, { println("File download failed $it") }, { bytesWritten, contentLength, percentage -> println("&gt;&gt; Percentage - $percentage") println("&gt;&gt; Bytes Written - $bytesWritten") println("&gt;&gt; Content Length - $contentLength") } ) }) -------------------------------------------------------------------------------- title: "ファイルの削除" description: "File Store内のフォルダーから既存のファイルを削除できます。" last_updated: "2026-06-10T06:04:54.099Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/file-store/delete-file/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Delete File - API (/ja/api/code-reference/cloud-scale/file-store/delete-file/#DeleteFile) -------------------------------------------------------------------------------- # ファイルの削除 **delete()**メソッドを呼び出し、ファイルインスタンスでファイルを参照することで、File Store内のフォルダーから既存のファイルを削除できます。これにより、ファイルは完全に削除されます。 以下のコードで使用されている&lt;FILE_INSTANCE&gt;は、サンプルコードスニペットに示すように、特定のファイルに対して作成されたインスタンスです。これは、一意のファイルIDによって削除する必要がある特定のフォルダーからのファイルを参照します。 &lt;FILE_INSTANCE&gt;.delete( success: () → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;Unit&gt;? 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getFileStoreInstance().getFolderInstance(2823000000006544).getFile(2823000000006589, //これをあなたのフォルダIDに置き換えてください and File ID { file -> file.delete( { println("File Deleted successfully") }) }, { exception -> println("Delete File Failed $exception") }) ##### Stratus -------------------------------------------------------------------------------- title: "概要" description: "このページでは、Stratus操作を実行するために必要なモバイルSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.099Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/stratus/overview/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/overview/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/overview/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/overview/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # 概要 Cloud Scale Stratusは、Catalystの堅牢で強力なストレージソリューションです。バケットと呼ばれるコンテナに、あらゆる形式のデータをオブジェクトの形で保存できます。各バケットおよびバケット内の個々のオブジェクトには、セキュアなオブジェクトURLとバケットURLがあります。オブジェクトに対してアップロードおよびダウンロード操作を実行でき、各オブジェクトにカスタム権限を提供することもできます。 以下の表には、コードを通じてStratus操作を実行するために使用できるすべてのCatalyst SDKの一覧が含まれています。 <table class="content-table"> <thead> <tr> <th class="w30p">カテゴリ</th> <th class="w70p">SDKメソッド</th> </tr> </thead> <tbody> <tr> <td>一般的なStratus操作</td> <td>バケットインスタンスの作成</td> </tr> <tr> <td>バケット操作</td> <td> <ul> <li>オブジェクトの取得 <ul> <li>すべてのオブジェクトの取得</li> </ul> </li> <li>オブジェクトのダウンロード</li> <li>オブジェクトのアップロード <ul> <li>ファイルパスと名前を使用したオブジェクトのアップロード</li> <li>ファイルパスを使用したオブジェクトのアップロード</li> <li>InputStreamとファイル名を使用したオブジェクトのアップロード</li> </ul> </li> <li>オブジェクトの削除 <ul> <li>単一オブジェクトの削除</li> <li>複数オブジェクトの削除</li> </ul> </li> <li>パスの削除</li> </ul> </td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "バケットインスタンスの作成" description: "このページでは、バケットインスタンスを作成するためのAndroid SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.103Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/create-bucket-instance/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/create-bucket-instance/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/create-bucket-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/initialize-stratus-instance/#initialize-bucket-instance) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/create-bucket-instance/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/initialize-stratus/#create-bucket-instance) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # バケットインスタンスの作成 バケットレベルの操作を実行するには、バケットインスタンスを初期化する必要があります。Stratusのバケットを操作するさまざまなコードスニペットで、このコンポーネントインスタンスを参照します。 var bucket = ZCatalystStratus.getBucketInstance("{bucket_name}") -------------------------------------------------------------------------------- title: "オブジェクトの取得" description: "このページでは、バケットからオブジェクトを取得するためのAndroid SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.103Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/stratus/get-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/get-objects/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/get-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/get-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/get-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/get-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/get-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-objects/#GetAllObjects) -------------------------------------------------------------------------------- # オブジェクトの取得 このSDKメソッドを使用して、バケットからオブジェクトを取得できます。レスポンスは**blob**形式になります。 バケットのバージョニングが有効な場合： * versionIdを渡さない場合、**最新のオブジェクト**のみが返されます。 * 特定のバージョンを取得するには、有効なバージョンを値としてversionIdクエリパラメータを使用してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w30p">パラメータ名</th> <th class="w70p">定義</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>必須パラメータ。オブジェクト名を含みます。</td> </tr> <tr> <td>versionId</td> <td>任意のパラメータ。必要なオブジェクトのバージョンの一意のバージョンIDを保持します。</td> </tr> </tbody> </table> bucketInstance.getObject("{object_name}", "{version_id}", { object -> println("The name of the object is : ${object.name}") }, { exception -> println("Get object failed! $exception") } ) ### すべてのオブジェクトの取得 このSDKメソッドを使用して、ページネーション技術を用いてバケット内のすべてのオブジェクトを取得できます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>prefix</td> <td>String</td> <td>任意のパラメータ。プレフィックス値に一致するオブジェクトを取得します。</td> </tr> <tr> <td>max_keys</td> <td>Number</td> <td>任意のパラメータ。ページネーションでリスト表示できるオブジェクトの最大数を含みます。</td> </tr> <tr> <td>continuation_token</td> <td>String</td> <td>任意のパラメータ。レスポンスが切り捨てられた場合、このキーの値を同じメソッドにcontinuation_tokenとして渡して、次のオブジェクトセットを取得する必要があります。</td> </tr> </tbody> </table> bucketInstance.getObjects({max_keys}, {continuation_token}, {prefix}, { objects -> for (obj in objects){ println("Object name: ${obj.name}") } }, { exception -> println("Get objects failed! $exception") } ) -------------------------------------------------------------------------------- title: "オブジェクトのダウンロード" description: "このページでは、バケットからオブジェクトをダウンロードするためのAndroid SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.104Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/stratus/download-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Download an Object (/ja/cloud-scale/help/stratus/objects/manage-object/download-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/range-download/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/range-download/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/range-download/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/range-download/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/download-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/download-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/upload-object/#DownloadObject) -------------------------------------------------------------------------------- # オブジェクトのダウンロード このSDKメソッドを使用して、オブジェクトをダウンロードできます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>versionId</td> <td>String</td> <td>任意のパラメータ。必要なオブジェクトのバージョンの一意のバージョンIDを保持します。</td> </tr> <tr> <td>fromCache</td> <td>Boolean</td> <td> <ul> <li>任意のパラメータ。このファイルをキャッシュから取得するかどうかを指定するために使用します。</li> <li>デフォルト値: false。</li> </ul> </td> </tr> </tbody> </table> bucketInstance.getObject("SunSet.jpeg", "2823000000044005", //オブジェクト名とオブジェクトIDに置き換えてください { object -> object.download( { println("File download success ${it.available()}") }, { println("File download failed $it") } ) } -------------------------------------------------------------------------------- title: "オブジェクトのアップロード" description: "このページでは、バケットにオブジェクトをアップロードするためのAndroid SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.104Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/stratus/upload-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Upload Object Help Documentation (/ja/cloud-scale/help/stratus/objects/upload-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/upload-object/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/upload-object/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/upload-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/upload-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/upload-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/upload-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/upload-object/#UploadObject) -------------------------------------------------------------------------------- # オブジェクトのアップロード このセクションに記載されたSDKメソッドを使用して、バケットにオブジェクトをアップロードできます。 オブジェクトのバージョニングが有効でない場合、Stratusが同じオブジェクトに対して複数の書き込みリクエストを受信すると、オブジェクトは継続的に上書きされます。最新のアップロードのみがバケットに保存されます。 ただし、バージョニングが有効な場合、各アップロードはオブジェクトのバージョンとして扱われ、すべてが一意のversionIdでバケットに保存されます。 注意: パスまたはオブジェクトを作成する際、スペースを含む以下の文字はサポートされていません：ダブルクォート、両方の山括弧、ハッシュタグ、バックスラッシュ、パイプ記号。 ### ファイルパスと名前を使用したオブジェクトのアップロード このSDKを使用して、完全な名前とパスを使用してバケットにオブジェクトをアップロードできます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>filePath</td> <td>String</td> <td>必須パラメータ。ファイルのアップロード元の場所の完全なパスを含みます。</td> </tr> <tr> <td>fileName</td> <td>String</td> <td> <ul> <li>必須パラメータ。オブジェクトの完全な名前を保持します。</li> <li>デフォルト値: 使用された最後のパス値を保持します。</li> </ul> </td> </tr> <tr> <td>shouldCompress</td> <td>Boolean</td> <td> <ul> <li>任意のパラメータ。オブジェクトを圧縮するかどうかを選択できます。</li> <li>デフォルト値: false。</li> </ul> </td> </tr> <tr> <td>progress</td> <td>Function</td> <td> <ul> <li>任意のパラメータ。ファイルアップロード時のコールバック関数です。</li> </ul> </td> </tr> </tbody> </table> bucketIntance.uploadObject("/Desktop", "Helplinecard.jpeg", true, { println(" >> Object Upload Success -$it") }, { println(" >> Object Upload Failed -$it") }, progress = { bytesWritten, contentLength, percentage -> println("Percentage: $percentage") } ) ### ファイルパスを使用したオブジェクトのアップロード このSDKを使用して、完全なパスを使用してバケットにオブジェクトをアップロードできます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>filePath</td> <td>String</td> <td>必須パラメータ。ファイルのアップロード元の場所の完全なパスを含みます。</td> </tr> <tr> <td>shouldCompress</td> <td>Boolean</td> <td> <ul> <li>任意のパラメータ。オブジェクトを圧縮するかどうかを選択できます。</li> <li>デフォルト値: false。</li> </ul> </td> </tr> <tr> <td>progress</td> <td>Function</td> <td> <ul> <li>任意のパラメータ。ファイルアップロード時のコールバック関数です。</li> </ul> </td> </tr> </tbody> </table> bucketIntance.uploadObject("/Desktop", "Helplinecard.jpeg", true, { println(" >> Object Upload Success -$it") }, { println(" >> Object Upload Failed -$it") }, progress = { bytesWritten, contentLength, percentage -> println("Percentage: $percentage") } ) ### InputStreamとファイル名を使用したオブジェクトのアップロード このSDKを使用して、ファイル名とアップロードするオブジェクトの入力ストリームを使用してバケットにオブジェクトをアップロードできます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>stream</td> <td>InputStream</td> <td>必須パラメータ。アップロードするオブジェクトの入力ストリームを含みます。</td> </tr> <tr> <td>fileName</td> <td>String</td> <td> <ul> <li>必須パラメータ。オブジェクトの完全な名前を保持します。</li> <li>デフォルト値: 使用された最後のパス値を保持します。</li> </ul> </td> </tr> <tr> <td>shouldCompress</td> <td>Boolean</td> <td> <ul> <li>任意のパラメータ。オブジェクトを圧縮するかどうかを選択できます。</li> <li>デフォルト値: false。</li> </ul> </td> </tr> <tr> <td>progress</td> <td>Function</td> <td> <ul> <li>任意のパラメータ。ファイルアップロード時のコールバック関数です。</li> </ul> </td> </tr> </tbody> </table> val file = File("/Desktop/HelplineCard.jpg") val inputStream: InputStream = FileInputStream(file) bucketIntance.uploadObject(inputSrream, "Helplinecard.jpeg", true, { println(" >> Object Upload Success -$it") }, { println(" >> Object Upload Failed -$it") }, progress = { bytesWritten, contentLength, percentage -> println("Percentage: $percentage") } ) -------------------------------------------------------------------------------- title: "オブジェクトの削除" description: "このページでは、バケットからオブジェクトを削除するためのAndroid SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.104Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/stratus/delete-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Delete an Object Help Documentation (/ja/cloud-scale/help/stratus/objects/manage-object/delete-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/delete-objects/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/delete-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/delete-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/delete-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/delete-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/delete-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/delete-objects/#DeleteObject) -------------------------------------------------------------------------------- # オブジェクトの削除 ### 単一オブジェクトの削除 以下のSDKメソッドを使用して、バケットから単一のオブジェクトを削除できます。 bucketInstance.getObject("SunSet.jpeg", "2823000000044005", //オブジェクト名とオブジェクトIDに置き換えてください { object -> object.delete( { println("Object Deletion Success.") }, { println("Failed to delete the object. $it") } ) ### 複数オブジェクトの削除 以下のSDKメソッドを使用して、バケットから複数のオブジェクトを削除できます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w30p">データ型</th> <th class="w50p">定義</th> </tr> </thead> <tbody> <tr> <td>objects</td> <td>ArrayList&lt;ZCatalystObject&gt;</td> <td>削除する必要があるオブジェクト（およびバケットのバージョニングが有効な場合はバージョンID）のリストを含む配列。</td> </tr> </tbody> </table> bucketInstance.getObjects( success = { objects, resInfo -> bucketInstance.deleteObjects(objects, { println("DELETE BULK OBJECTS : SUCCESS"), }, { println("Delete Objects Failed: $it") } ) -------------------------------------------------------------------------------- title: "パスの削除" description: "このページでは、バケットからパス全体とそのオブジェクトを削除するためのAndroid SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.104Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/stratus/delete-path/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Delete an Object Help Documentation (/ja/cloud-scale/help/stratus/objects/manage-object/delete-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/delete-objects/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/delete-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/delete-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/delete-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/delete-path/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/delete-path/) - REST API (/ja/api/code-reference/cloud-scale/stratus/delete-path/#DeletePath) -------------------------------------------------------------------------------- # パスの削除 以下のSDKメソッドを使用して、指定したパス内のすべてのオブジェクトを削除できます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>path</td> <td>String</td> <td>必須パラメータ。ファイルをアップロードする場所の完全なパスを含みます。</td> </tr> </tbody> </table> bucketInstance.deletePath("myFolder/", { println("Objects deleted successfully.") }, { println("Failed to delete the objects - $it") } ) ##### ZCQL -------------------------------------------------------------------------------- title: "ZCQLクエリの実行" description: "ZCQLは、Data Storeでのデータ作成、取得、および変更操作を可能にするCatalyst独自のクエリ言語です。" last_updated: "2026-06-10T06:04:54.108Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/zcql/execute-zcql-query/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - ZCQL (/ja/cloud-scale/help/zcql/introduction/) - Execute ZCQL - API (/ja/api/code-reference/cloud-scale/zcql/execute-zcql-query/#ExecuteZCQLQuery) -------------------------------------------------------------------------------- # ZCQL ZCQLは、Data Storeでのデータ作成、取得、および変更操作を可能にするCatalyst独自のクエリ言語です。組み込み関数、SQL Join句、およびその他のステートメントや条件を使用したクエリをサポートしています。 ### ZCQLクエリの実行 必要なデータセットを取得するためのZCQLクエリを実行する前に、**execute()**メソッドに渡すクエリを構築する必要があります。ZCQL構文については、ZCQLヘルプページから学ぶことができます。 以下のZCQLクエリ実行のコード構文に示すように、**ZCatalystSelectQuery**のインスタンスをexecute()メソッドに渡す必要があります。 ここで使用されている&lt;DATA_STORE_INSTANCE&gt;は、Data Storeインスタンスページで定義されたインスタンスです。 ZCatalystApp.getInstance().getDataStoreInstance().execute( selectQuery: ZCatalystSelectQuery, success: (List&lt;Map&lt;String, Map&lt;String, Any?&gt;&gt;&gt;) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;List&lt;Map&lt;String, Any?&gt;&gt;&gt;&gt;&gt;? **パラメータ**: * **selectQuery**: ZCatalystSelectQuery型のインスタンス ZCQLでサポートされるステートメントのZCatalystSelectQueryに対して、以下の方法でselectQueryインスタンスを作成できます： ZCatalystSelectQuery.Builder() .select(columns: Set&lt;Column&gt;): ZCatalystSelectQuery.Builder .selectAll(): ZCatalystSelectQuery.Builder .where(column: String, comparator: ZCatalystUtil.Comparator, value: String): ZCatalystSelectQuery.Builder .from(tableName: String): ZCatalystSelectQuery.Builder .and(column: String, comparator: ZCatalystUtil.Comparator, value: String): ZCatalystSelectQuery.Builder .groupBy(columns: Set&lt;Column&gt;): ZCatalystSelectQuery.Builder .orderBy(columns: Set&lt;Column&gt;, sortOrder: ZCatalystUtil.SortOrder): ZCatalystSelectQuery.Builder .innerJoin(tableName: String): ZCatalystSelectQuery.Builder .leftJoin(tableName: String): ZCatalystSelectQuery.Builder .on(joinColumn1: String, comparator: ZCatalystUtil.Comparator, joinColumn2: String): ZCatalystSelectQuery.Builder .or(column: String, comparator: ZCatalystUtil.Comparator, value: String): ZCatalystSelectQuery.Builder .limit(offset: Int, value: Int?): ZCatalystSelectQuery.Builder .build(): ZCatalystSelectQuery 以下にZCQLクエリ実行のサンプルコードスニペットを示します： val query = ZCatalystSelectQuery.Builder() .selectAll() .from("EmployeeDetails") //これをあなたのテーブル名に置き換えてください .where("Location", ZCatalystUtil.Comparator.EQUAL_TO, "Austin") .and("Department", ZCatalystUtil.Comparator.EQUAL_TO, "Marketing") .or("isActive", ZCatalystUtil.Comparator.EQUAL_TO, "true") .limit(5) .build() ZCatalystApp.getInstance().getDataStoreInstance().execute(query, { println("Query executed successfully. $it") }, { exception -> println("Exception occured $exception") }) ##### プッシュ通知 -------------------------------------------------------------------------------- title: "プッシュ通知のデバイス登録" description: "このページでは、Androidアプリを登録してエンロールした後、Androidデバイスをリモートプッシュ通知に登録するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.112Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/push-notifications/register-device/" service: "Cloud Scale" related: - Push Notifications (/ja/cloud-scale/help/push-notifications/introduction) - Android Push Notifications (/ja/cloud-scale/help/push-notifications/android) - Push Notifications API for Android Devices (/ja/api/code-reference/cloud-scale/push-notifications/android/send-android-push-notifications/#SendAndroidPushNotifications) - Push Notifications Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/push-notifications/register-device/) -------------------------------------------------------------------------------- # プッシュ通知 ### はじめに Catalystプッシュ通知を使用すると、アプリがユーザーのデバイスでアクティブに実行されていない場合でも、アプリケーションのユーザーにリモート通知を送信できます。Catalystは、プッシュ通知をCatalystのWeb、iOS、およびAndroidアプリケーションに統合する簡単な方法を提供します。 プッシュ通知を送信する前に、アプリを登録してCatalystプッシュ通知にエンロールするための一連の手順に従う必要があります。これらの手順を以下に順番に示します： 1. FirebaseのAndroid構成ファイルの生成 2. Firebaseアクセス用の秘密鍵の生成 3. CatalystでのAndroidプッシュ通知サービスの設定 4. プッシュ通知用のモバイルデバイスの登録 注意: 最初の3つの手順は、プッシュ通知 - Androidヘルプセクションで詳しく説明されています。このAndroid SDKヘルプドキュメントでは、デバイスを登録してプッシュ通知を送信する4番目の手順と、デバイスの登録解除についてのみ説明します。以下のコードを使用する前に、プッシュ通知ヘルプドキュメントを参照して手順1〜3を実装できます。 <br> ### プッシュ通知用のモバイルデバイスの登録 上記の最初の5つの手順を完了した後、Androidアプリに以下のコードを実装して、Catalystプッシュ通知にデバイスを登録できます。 Androidモバイルデバイスをテストデバイスとして登録するには、以下のコードスニペットに示すように、必要なパラメータを指定してregisterNotification()メソッドを呼び出す必要があります： val app = ZCatalystApp.getInstance() app.registerNotification(device_token,"bundleID", "appID", test_device_boolean, { Log.i("Register","App register successfully"); }, { Log.i("Register","App register failed"); }) **パラメータ:** * device_token: アプリのFCMから取得したデバイストークン。 * bundleID: Catalystにアプリを登録する際、およびFirebaseで設定したAndroidアプリのバンドルID。 * appID: プッシュ通知でCatalystがアプリに対して生成したアプリID。これは、CatalystコンソールのPush NotificationsのAndroidセクションで確認できます。 * test_device_boolean: テストデバイスの場合はtrueに設定し、本番デバイスの場合はfalseに設定します。 <br> 注意: Androidプッシュ通知をテストするために、最大10台のAndroidデバイスをテストデバイスとして登録できます。 デバイスが登録されると、アプリユーザーにプッシュ通知を送信できるようになります。ユーザーは、権限プロンプトから**許可**をクリックして、デバイスにプッシュ通知を送信するためのアプリの権限を提供する必要があります。 Catalystコンソールから登録済みデバイスにテストプッシュ通知を送信する方法については、このヘルプセクションを参照してください。APIからテスト通知を送信することもできます。 コードベースを通じてプッシュ通知を送信する方法については、Java、Node.js、およびPython SDKドキュメントを参照してください。 -------------------------------------------------------------------------------- title: "プッシュ通知のデバイス登録解除" description: "このページでは、登録済みのAndroidデバイスをリモートプッシュ通知から登録解除するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.113Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/push-notifications/deregister-device/" service: "Cloud Scale" related: - Push Notifications (/ja/cloud-scale/help/push-notifications/introduction) - Android Push Notifications (/ja/cloud-scale/help/push-notifications/android) - Push Notifications API for Android Devices (/ja/api/code-reference/cloud-scale/push-notifications/android/send-android-push-notifications/#SendAndroidPushNotifications) -------------------------------------------------------------------------------- # プッシュ通知用のモバイルデバイスの登録解除 以下に示すように、必要なパラメータをderegisterNotification()メソッドに渡すことで、Catalyst Androidプッシュ通知に登録されたデバイスの登録を解除できます。 val app = ZCatalystApp.getInstance() app.deregisterNotification (device_token,"bundleID", "appID", test_device_boolean, { Log.i("Unregister","App unregistered successfully"); }, { Log.i("Unregister","App unregisteration failed"); }) **パラメータ:** * device_token: アプリのFCMから取得したデバイストークン。 * bundleID: Catalystにアプリを登録する際、およびFirebaseで設定したAndroidアプリのバンドルID。 * appID: プッシュ通知でCatalystがアプリに対して生成したアプリID。これは、CatalystコンソールのPush NotificationsのAndroidセクションで確認できます。 * test_device_boolean: テストデバイスの場合はtrueに設定し、本番デバイスの場合はfalseに設定します。 ##### 検索 -------------------------------------------------------------------------------- title: "テーブル内のデータ検索" description: "Catalyst Searchは、Data Store内のテーブルのインデックス付きカラムでのデータ検索を可能にします。単一の検索クエリで大量のデータを強力に検索できます。" last_updated: "2026-06-10T06:04:54.113Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/search/search-data-in-tables/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Search (/ja/cloud-scale/help/search-integration/introduction) - Search - API (/ja/api/code-reference/cloud-scale/zcql/execute-zcql-query/#ExecuteZCQLQuery) -------------------------------------------------------------------------------- # Search Catalyst Searchは、Data Store内のテーブルのインデックス付きカラムでのデータ検索を可能にします。単一の検索クエリで大量のデータを強力に検索できます。 注意: データを検索するカラムはインデックス付きである必要があります。カラムの作成時に検索インデックスを有効にするか、後から編集して有効にできます。 ### テーブル内のデータ検索 特定のパターンでテーブル内のデータを検索するには、テーブル名を識別子として指定し、検索するカラムを追加する必要があります。カラムは配列に追加でき、その配列をクラスZCatalystSearchOptionsのインスタンスを通じて、検索キーワードとともに**search()**メソッドに渡す必要があります。 以下のコード構文に示すように、検索操作を実行する前に、search()メソッドに渡す検索パターンを構築する必要があります。 ZCatalystApp.getInstance().search( searchOptions: ZCatalystSearchOptions, success: (Map&lt;String, List&lt;Map&lt;String, Any?&gt;&gt;&gt;) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;Map&lt;String, List&lt;Map&lt;String, Any?&gt;&gt;&gt;&gt;&gt;? **パラメータ**: * **searchOptions**: search()メソッドに渡す**ZCatalystSearchOptions**クラスのインスタンス searchOptions()のインスタンスは以下の方法で作成できます： ZCatalystSearchOptions(searchText: String, ArrayList&lt;ZCatalystSearchOptions.TableColumns) .addSortColumn(tableName: String,columnName: String): Unit .setDisplayColumns(displayTableColumns: ArrayList&lt;ZCatalystSearchOptions.TableColumns&gt;): Unit .setSearchColumns(searchTableColumns: ArrayList&lt;ZCatalystSearchOptions.TableColumns&gt;): Unit .setSearchPattern(pattern: ZCatalystSearchOptions.SearchPattern): Unit 以下に検索実行のサンプルコードスニペットを示します： val tableColumns = ZCatalystSearchOptions.TableColumns("EmployeeDetails") //これをあなたのテーブル名に置き換えてください tableColumns.addColumn("Age") //これをあなたの列名に置き換えてください val arr = arrayListOf<ZCatalystSearchOptions.TableColumns>() arr.add(tableColumns) val searchOptions = ZCatalystSearchOptions("26",arr) //これをあなたの検索テキストに置き換えてください ZCatalystApp.getInstance().search(searchOptions, { println(">> success - $it") }, { println(">> failed - $it") }) ##### 認証 -------------------------------------------------------------------------------- title: "ユーザーインスタンスの作成" description: "Catalyst Authenticationの機能を使用すると、Catalystアプリのユーザー認証の管理、ユーザーの追加、およびユーザーアカウントの設定を行うことができます。" last_updated: "2026-06-10T06:04:54.113Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/authentication/create-user-instance/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Add New User - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # Authentication Catalyst Authenticationは、Catalyst Cloud Scaleのコンポーネントであり、アプリケーションにエンドユーザーを追加し、アプリのログインおよびサインアップフォームをカスタマイズし、ユーザーアカウントとロールを管理し、アプリケーション全体にわたる安全なアクセスを確保することができます。 ## 新しいユーザーインスタンスの作成 新しいユーザーインスタンスを作成し、このクラスで定義されているメソッドを有効にしてインスタンスオブジェクトにアクセスすることができます。これにより、不要なサーバー呼び出しを防ぐことができます。 以下のコード構造に示すように、**newUser()**メソッドにユーザーの詳細を渡す必要があります。インスタンスを正常に作成するには、ユーザーのメールアドレスと姓を必須で渡す必要があります。 ZCatalystApp.getInstance().newUser( lastName: String, email:String ): ZCatalystUser **パラメータ**: * **lastName**: 新しいユーザーの姓 * **email**: 招待メールが送信されるユーザーのメールアドレス 以下にサンプルコードスニペットを示します： val user = ZCatalystApp.getInstance().newUser("Burrows", "emma@zylker.com") -------------------------------------------------------------------------------- title: "ユーザーサインアップ" description: "Catalystアプリケーションに新しいユーザーを追加します。" last_updated: "2026-06-10T06:04:54.113Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/authentication/user-signup/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Authentication - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # ユーザーサインアップ **signUp()**メソッドを呼び出すことで、Catalystアプリに新しいユーザーを追加できます。signup()メソッドの引数として、ここで定義したユーザーインスタンスを渡す必要があります。 ユーザーサインアップのコード構文を以下に示します： ZCatalystApp.getInstance().signUp( newUser: ZCatalystUser, success: (Pair&lt;ZCatalystOrg, ZCatalystUser&gt;) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;Pair&lt;ZCatalystOrg, ZCatalystUser&gt;&gt;&gt;? **パラメータ**: * **newUser**: この操作の前に作成されたユーザーインスタンス 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().signUp(user, { success -> println("User Sign up success") }, { exception -> println("User Sign up failed $exception") }) -------------------------------------------------------------------------------- title: "ユーザーログイン" description: "Catalyst Androidアプリのエンドユーザーにログインページを表示できます。" last_updated: "2026-06-10T06:04:54.113Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/authentication/user-login/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Authentication - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # ユーザーログイン **login()**メソッドを使用して、Catalyst Androidアプリのエンドユーザーにログインページを表示できます。これは、ユーザーがアプリからログアウトしている状態で表示されます。ログインが成功すると、ユーザーはアプリにアクセスできるようになります。 ユーザーログインのコード構文を以下に示します： ZCatalystApp.getInstance().login( success: () → Unit, failure: (ZCatalystException) → Unit ): Unit 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().login( { ZCatalystLogger.logInfo("Login Success") //ログイン成功時に実行するアクション }, { ZCatalystLogger.logError("Login failed - $it") //ログイン失敗時に実行するアクション }) ZCatalystLoggerクラスのメソッドは、操作の結果をログに記録するために使用されます。ログインの成功または失敗時に実行する独自のアクションを定義できます。 -------------------------------------------------------------------------------- title: "ユーザーログアウト" description: "Catalyst Androidアプリからアプリユーザーをログアウトさせることができます。" last_updated: "2026-06-10T06:04:54.113Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/authentication/user-logout/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Logout User - API (/ja/api/code-reference/cloud-scale/authentication/sign-out-user/#SignOutUser) -------------------------------------------------------------------------------- # ユーザーログアウト logout()メソッドを使用すると、Catalyst Androidアプリからアプリユーザーをログアウトさせることができます。 ユーザーログアウトのコード構文を以下に示します： ZCatalystApp.getInstance().logout( success: () → Unit, failure: (ZCatalystException) → Unit ): Unit 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().logout( { ZCatalystLogger.logInfo("Logout Success") //ログアウト成功時に実行するアクション }, { ZCatalystLogger.logError("Logout failed - $it") //ログアウト失敗時に実行するアクション }) ZCatalystLoggerクラスのメソッドは、操作の結果をログに記録するために使用されます。ログアウトの成功または失敗時に実行する独自のアクションを定義できます。 -------------------------------------------------------------------------------- title: "現在のユーザーの取得" description: "アプリケーションの現在のエンドユーザーの詳細を取得できます。" last_updated: "2026-06-10T06:04:54.113Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/authentication/get-current-user/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Add New User - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # 現在のユーザーの取得 getCurrentUser()メソッドを呼び出すことで、アプリケーションの現在のエンドユーザーの詳細を取得できます。正常に実行されると、このメソッドは現在のユーザーオブジェクトを返します。これを使用して、Catalystに登録されているユーザーの名、姓、メールアドレスなどの詳細を取得できます。 現在のユーザーを取得するためのコード構文を以下に示します： ZCatalystApp.getInstance().getCurrentUser( success: (ZCatalystUser) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;ZCatalystResponse&lt;ZCatalystUser&gt;&gt;? 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getCurrentUser( { user -> println("The current user is : ${user.firstName}") }, { exception -> println("Get current user failed! $exception") } ) -------------------------------------------------------------------------------- title: "ソーシャルログイン" description: "AndroidアプリでSocial Loginsを通じてネイティブのGoogleログインおよびログアウトを提供できます。" last_updated: "2026-06-10T06:04:54.114Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/authentication/social-logins/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Social Logins (/ja/cloud-scale/help/authentication/social-logins/introduction/) - Google Login (/ja/cloud-scale/help/authentication/social-logins/configuring-social-logins/#enable-google-social-login) - Authentication - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # Social Logins Catalystでは、Authenticationを通じて、エンドユーザーが一般的なIdentity Providers (IdP)またはSocial Loginsを使用してアプリケーションにログオンできるようにすることができます。Catalyst Android SDKでは、AndroidアプリユーザーにGoogleのログインおよびログアウト機能を提供できます。 Note: Social Loginsを使用するには、Public Signupを有効にする必要があります。 ### Google Login Catalystで認証を設定することにより、AndroidアプリにネイティブのGoogleログインを提供できます。そのためには、Google API consoleにアプリを登録し、クライアントIDとクライアントシークレットを含む必要なOAuth認証情報を取得する必要があります。 このプロセスに含まれる手順については、Enable Google Social Loginのヘルプセクションをご覧ください。 Note: ステップ12では、アプリケーションタイプをWebアプリケーションとして設定する必要があります。 CatalystコンソールでGoogle Social Loginの設定が完了したら、Googleから取得したクライアントIDを渡して、以下のようにユーザーログインを実行できます。 fun login(activity: Activity, googleClientID: String, success: () -> Unit, failure: (ZCatalystException) -> Unit) **パラメータ**: * **googleClientID**: Google API consoleでOAuthを設定した後に取得したクライアントID 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().login("activity", "570*******************", { success -> println("User login success") }, { exception -> println("User login failed $exception") }) ### Google Logout Google API consoleでOAuthを設定した後にGoogleから取得したクライアントIDを渡すことで、Catalyst AndroidアプリからユーザーのGoogleログインをログアウトさせることができます。以下のように実行します。 fun logout(activity: Activity, googleClientID: String, success: () -> Unit, failure: (ZCatalystException) -> Unit) **パラメータ**: * **googleClientID**: Google API consoleでOAuthを設定した後に取得したクライアントID 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().logout("activity", "570*******************", { println("Logout success") }, { println("Logout failed $exception") }) -------------------------------------------------------------------------------- title: "サードパーティ認証" description: "Androidアプリに任意のサードパーティ認証サービスを実装できます。" last_updated: "2026-06-10T06:04:54.114Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/authentication/third-party-authentication/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Third-Party Authentication (/ja/cloud-scale/help/authentication/third-party-authentication/introduction/) - Generate Custom Server Token- Java SDK (/ja/sdk/java/v1/cloud-scale/authentication/third-party-server-token/) - Generate Custom Server Token- Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/authentication/third-party-server-token/) - Generate Custom Server Token- Python SDK (/ja/sdk/python/v1/cloud-scale/authentication/third-party-server-token/) - Authentication - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # サードパーティ認証 Cloud ScaleのAuthenticationでは、Catalystアプリケーションに任意のサードパーティ認証サービスを実装できます。エンドユーザーの認可と検証はサードパーティサービスによって処理され、データはCatalystに渡されます。 Note: サードパーティの認証サービスを実装するため、アプリケーションのセキュリティインフラストラクチャは、選択したサードパーティサービスの効率性に依存することをご理解ください。 Androidアプリにサードパーティ認証を実装するには、以下に説明する手順を実行する必要があります。 ### 1. サードパーティ認証サービスの設定 サードパーティ認証をCatalystアプリケーションに関連付ける前に、外部サービスでのサードパーティのロジックの処理を最初に完了させていることを確認する必要があります。任意のサードパーティで認証を設定できます。 <br> ### 2. Catalystでサードパーティ認証タイプをセットアップする CatalystコンソールのCloud Scale内のAuthenticationコンポーネントに移動して、設定したサードパーティ認証をCatalystでセットアップする必要があります。手順はCatalystでのサードパーティ認証のセットアップのヘルプページで説明されています。 このプロセスには、以下の手順が含まれます： **i. カスタムサーバートークンの生成：** サードパーティサービスで認証された後にユーザーがリダイレクトされると、そのユーザーの認証情報をJava、Node.js、またはPythonでコーディングする認証関数に渡す必要があります。この関数はCatalystのサーバーサイドトークン**jwtToken**または**customToken**を生成し、クライアントサイド（Androidアプリ）に渡されます。Catalystコンソールでは、customTokenを生成するための既製スクリプトが提供されています。このスクリプトを、作成するサーバーサイド関数に組み込んでcustomTokenを返すことができます。 Note: Catalystアプリケーションでサードパーティ認証を有効にするには、コンソールでPublic Signupを有効にしていることを確認する必要があります。 **ii. クライアントサイドの設定をスキップする：** 最後にログインプロセスを完了するためにクライアントロジックにカスタムサーバートークンを組み込むため、今はコンソールでのクライアントサイドの設定をスキップできます。 **iii. 追加設定を行いセットアップを完了する：** ホワイトリストの一部としてカスタムユーザー検証または許可ドメインを設定し、セットアップを完了します。 Catalystは、サードパーティ認証サービスが有効になり、アプリケーションの認証がそのサービスによって処理されていることを確認するメッセージを表示します。 <br> ### 3. Androidプロジェクトに設定ファイルを再インポートする CatalystコンソールからAndroidアプリのサードパーティ認証を有効にした後、アプリの環境に基づいて、Androidプロジェクトにapp_configuration_developmentまたはapp_configuration_productionプロパティファイルを再度ダウンロードしてインポートする必要があります。これは、このファイルに2つの追加プロパティ（JWTClientIDとJWTClientSecret）が含まれるようになるためです。これらのプロパティは、SDKを再初期化した後の次のステップで渡す必要があります。 設定ファイルを再ダウンロードするには： 1. プロジェクトのCatalystコンソールで**Settings**に移動し、次に**Developer Tools**に移動します。Mobile SDKセクションの下に既存のAndroidパッケージがあります。パッケージを開きます。 <br> 2. ポップアップで必要な環境タブをクリックし、**Download**をクリックして設定ファイルをダウンロードします。 <br> ダウンロードした設定ファイルは、こちらの手順に従って再インポートできます。 Note: SDKセットアップのヘルプページに記載されているステップ3〜5は再度実行する必要はありません。 <br> ### 4. SDKを再初期化する 新しくダウンロードしたプロパティをコードに含めるために、SDKを再初期化する必要があります。SDKの再初期化も、初回のSDK初期化と同様に2つの方法で行うことができます：プロジェクトの環境を指定する方法と、環境を指定せずにProduction環境をデフォルトとする方法です。ただし、サードパーティ認証を確認するための追加のSDKメソッドが含まれます。 #### 方法 1: 環境を指定する 以下のようにSDKを再初期化できます。アプリが動作している環境に基づいて、EnvironmentにDEVELOPMENTまたはPRODUCTIONの値を渡すことができます。isCustomLoginは、サードパーティ認証の存在を示すブール値です。 以下のように、ZCatalystAppクラスを通じてinit()メソッドに渡します： fun init( context: Context, environment: ZCatalystSDKConfigs.Environment, isCustomLogin: Boolean = false ): ZCatalystApp この操作のサンプルコードスニペットを以下に示します： ZCatalystApp.init( context, ZCatalystSDKConfigs.Environment.{DEVELOPMENT}, true ) <br> #### 方法 2: 環境を指定しない SDK初期化時にEnvironmentが指定されていない場合、デフォルトでPRODUCTIONとみなされます。この方法では、新しくダウンロードした設定ファイルから取得したJWTClientIDとJWTClientSecretプロパティをZCatalystSDKConfigsBuilderを通じて指定してSDKを再初期化することもできます。 以下の方法で行うことができます： fun init(context: Context, sdkConfigs: ZCatalystSDKConfigs, isCustomLogin: Boolean = false): ZCatalystApp 以下にサンプルコードスニペットを示します： val sdkConfigs = ZCatalystSDKConfigs.Builder( apiBaseURL: 'https://api.catalyst.zoho.com', clientID: '100****************************FX', //JWTクライアントID clientSecret: '19ed***************************2s', //JWTクライアントシークレット redirectURL: '*****', oauthScopes: 'ZOHOCATALYST.tables.rows.ALL, ZOHOCATALYST.tables.columns.ALL', portalID: '10******79', projectID: 28*******90 ).setAccountsPortalBaseURL('https://accounts.zohoportal.com') .setUserAgent("ZCatalyst Sample App") .setRequestHeaders('PORTAL_ID', '*********') .build(); ZCatalystApp.init(context, sdkConfigs, true) <br> ### 5. サードパーティ認証のユーザーログインロジックをコーディングする Androidアプリでサードパーティ認証のログインロジックを処理して、セットアップを完了できます。[ステップ2](/ja/sdk/android/v2/cloud-scale/authentication/third-party-authentication/#2-set-up-the-third-party-authentication-type-in-catalyst)で生成したcustomTokenまたはjwtTokenを、以下のようにhandleCustomLogin()メソッドに渡す必要があります： fun handleCustomLogin(jwtToken :String, success: () -> Unit, failure: (ZCatalystException) -> Unit) 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().handleCustomLogin("123xxxxxxxx", { println("Login successfully.") }, { println("Login failed.") }) Note: カスタムサーバートークンは、ユーザーがサードパーティ認証サービスを使用してアプリケーションにログインするたびに生成する必要があります。 #### General -------------------------------------------------------------------------------- title: "現在のタイムゾーンの取得" description: "プロジェクトでアクティブな現在のタイムゾーンを取得できます。" last_updated: "2026-06-10T06:04:54.114Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/general/get-current-time-zone/" service: "All Services" related: - Time Zone Settings (/ja/getting-started/set-up-a-catalyst-project/general-settings/#change-the-time-zone-of-the-project) -------------------------------------------------------------------------------- # 現在のタイムゾーンの取得 コンソールの一般設定から、プロジェクトのタイムゾーンを定義して保存できます。これにより、アクセスするデータセンターに基づいて設定されたデフォルトのタイムゾーンが上書きされます。設定したタイムゾーンは、プロジェクトのすべてのサービス、コンポーネント、および機能に適用されます。ただし、特定のコンポーネントに対して個別のタイムゾーンを定義することもできます。 Catalystでは、プロジェクトでアクティブな現在のタイムゾーンを取得できます。以下の構文に示すように、ZCatalystUtilクラスのgetCurrentTimeZone()メソッドを使用して、コンソールでプロジェクトに定義された現在のタイムゾーンを取得できます。 fun getCurrentTimeZone( success: (String) -> Unit, failure: ((ZCatalystException) -> Unit)? = null): ZCatalystRequest&lt;ZCatalystResponse&lt;JsonObject&gt;&gt;? 以下にサンプルコードスニペットを示します： ZCatalystUtil.getCurrentTimeZone({ timeZone -> println("Current time zone + $timeZone") }, { println("Failed to get current time zone.") }) #### Serverless ##### ファンクション -------------------------------------------------------------------------------- title: "ファンクションインスタンスの作成" description: "Catalystファンクションを使用すると、アプリケーションにカスタム機能を構築したり、タスクを自動化したり、サードパーティサービスと統合したりできます。" last_updated: "2026-06-10T06:04:54.117Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/serverless/functions/create-function-instance/" service: "Serverless" related: - Functions (/ja/serverless/help/functions/introduction) - Function - API (/ja/api/code-reference/serverless/functions/execute-function/#ExecuteFunction) -------------------------------------------------------------------------------- # Functions Catalyst Serverless Functionsを使用すると、アプリケーションにカスタム機能を構築したり、タスクを自動化したり、サードパーティサービスと統合したりできます。CatalystコンソールまたはCLIからAndroidアプリのファンクションを開発できます。 注意: Catalystでは、Basic I/O、Advanced I/O、Cron、Event、Integration、Browser Logicの6種類のファンクションを作成できます。ただし、Catalyst Android SDKではBasic I/Oファンクションのみ実行できます。 ### ファンクションインスタンスの作成 **getFunctionInstance()**メソッドを使用してCatalystファンクションのインスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。これにより、不要なサーバー呼び出しを防ぐことができます。 以下のいずれかの方法でファンクションインスタンスを作成できます： ### ファンクションIDを渡してファンクションインスタンスを作成する ファンクションの一意のファンクションIDを引数としてgetFunctionInstance()メソッドに渡し、インスタンスを作成できます： ZCatalystApp.getInstance().getFunctionInstance( id: Long ): ZCatalystFunction **パラメータ**: * **id**: ファンクションの一意のファンクションID 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getFunctionInstance(2823000000011091) //ここに関数IDを入力してください ### ファンクションのAPI名を渡してファンクションインスタンスを作成する ファンクションのAPI名を引数としてgetFunctionInstance()メソッドに渡し、インスタンスを作成できます： ZCatalystApp.getInstance().getFunctionInstance( apiName: String ): ZCatalystFunction **パラメータ**: * **apiName**: Catalystで設定されたファンクションの名前 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getFunctionInstance("LocalBackup") //ここに関数名を入力してください -------------------------------------------------------------------------------- title: "ファンクションの実行" description: "ファンクションに渡すHTTPリクエストに基づいて、いくつかの方法でCatalystファンクションを実行できます。" last_updated: "2026-06-10T06:04:54.117Z" source: "https://docs.catalyst.zoho.com/ja/sdk/android/v2/serverless/functions/execute-function/" service: "Serverless" related: - Functions (/ja/serverless/help/functions/introduction) - Implementing Functions (/ja/serverless/help/functions/implementation) - Execute Function - API (/ja/api/code-reference/serverless/functions/execute-function/#ExecuteFunction) -------------------------------------------------------------------------------- # ファンクションの実行 ファンクションに渡すHTTPリクエストに基づいて、以下のいずれかの方法でCatalyst Basic I/Oファンクションを実行できます。実行するファンクションにパラメータをファンクション実行メソッドの引数として渡すことができます。このメソッドはHTTPリクエストタイプごとに異なります。 以下のすべてのコードセクションで使用されている&lt;FUNCTION_INSTANCE&gt;は、ファンクションインスタンスページで定義されたインスタンスです。 ### GETファンクションの実行 パラメータをHashマップとして**executeGet()**メソッドに渡すことで、HTTP GETタイプのファンクションを実行できます： &lt;FUNCTION_INSTANCE&gt;.executeGet( params: HashMap&lt;String, Any&gt;, success: (String) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;String&gt;? **パラメータ**: * **params**: Hashマップとしてファンクションに渡すパラメータ 以下にサンプルコードスニペットを示します： ZCatalystApp.getInstance().getFunctionInstance(2823000000097020).executeGet( //ここに関数IDを入力してください hashMapOf(), { println(">> GET function executed successfully - $it") }, { println(">> GET function failed to execute - $it") } ) <br> ### PUTファンクションの実行 パラメータをHashマップとして**executePut()**メソッドに渡すことで、HTTP PUTタイプのファンクションを実行できます。PUTリクエストのペイロードもHashマップ引数としてこのメソッドに渡すことができます： &lt;FUNCTION_INSTANCE&gt;.executePut( params: HashMap&lt;String, Any&gt;, body: HashMap&lt;String, Any&gt;, success: (String) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;String&gt;? **パラメータ**: * **params**: Hashマップとしてファンクションに渡すパラメータ * **body**: Hashマップとして渡すデータペイロード 以下にサンプルコードスニペットを示します： val body = HashMap&lt;String, Any&gt;() body.put("ROWID", "2823000000098012") body.put("Category", "Important") //ハッシュマップにキーと値を追加する ZCatalystApp.getInstance().getFunctionInstance(2823000000097114).executePut( //ここに関数IDを入力してください hashMapOf(), body, { println(" &gt;&gt; PUT function executed successfully - $it") }, { println(" &gt;&gt; PUT function failed to execute - $it") } ) <br> ### POSTファンクションの実行 パラメータをHashマップとして**executePOST()**メソッドに渡すことで、HTTP POSTタイプのファンクションを実行できます。POSTリクエストのペイロードもHashマップ引数としてこのメソッドに渡すことができます： &lt;FUNCTION_INSTANCE&gt;.executePost( params: HashMap&lt;String, Any&gt; , body: HashMap&lt;String, Any&gt; , success: (String) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;String&gt;? **パラメータ**: * **params**: Hashマップとしてファンクションに渡すパラメータ * **body**: Hashマップとして渡すデータペイロード 以下にサンプルコードスニペットを示します： val body = HashMap&lt;String, Any&gt;() body.put("Title", "Data Migration Tasks") body.put("Category", "Official") //ハッシュマップにキーと値を追加する ZCatalystApp.getInstance().getFunctionInstance(2823000000097089).executePost( //ここに関数IDを入力してください hashMapOf(), body, { println(" &gt;&gt; POST function executed successfully - $it") }, { println(" &gt;&gt; POST function failed to execute - $it") } ) <br> ### DELETEファンクションの実行 パラメータをHashマップとして**executeDelete()**メソッドに渡すことで、HTTP DELETEタイプのファンクションを実行できます。DELETEリクエストのペイロードもHashマップ引数としてこのメソッドに渡すことができます： &lt;FUNCTION_INSTANCE&gt;.executeDelete( params: HashMap&lt;String, Any&gt;, success: (String) → Unit, failure: ((ZCatalystException) → Unit)? ): ZCatalystRequest&lt;String&gt;? **パラメータ**: * **params**: Hashマップとしてファンクションに渡すパラメータ 以下にサンプルコードスニペットを示します： val body = HashMap&lt;String, Any&gt;() ZCatalystApp.getInstance().getFunctionInstance(2823000000097089).executeDelete( //ここに関数IDを入力してください hashMapOf() { println(" >> DELETE function executed successfully - $it") }, { println(" >> DELETE function failed to execute - $it") } ) ## Flutter ### v2 -------------------------------------------------------------------------------- title: "概要" description: "Catalyst Flutter SDKは、Catalystプロジェクト向けにAndroidおよびiOSのネイティブモバイルアプリを構築できるライブラリです。Catalyst Flutter SDKパッケージには、強力なバックエンドを備えた動的で堅牢なモバイルアプリの開発を支援するさまざまなツールと機能が含まれています。" last_updated: "2026-06-10T06:04:54.118Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/overview/" service: "All Services" related: - Mobile Device Management (/ja/cloud-scale/help/mobile-device-management/introduction) - iOS SDK (/ja/sdk/ios/v2/overview/) - Android SDK (/ja/sdk/android/v2/overview/) - Web SDK (/ja/sdk/web/v4/overview/) -------------------------------------------------------------------------------- # Flutter SDK ## 概要 Flutterは、Googleが開発したDartプログラミング言語をベースとしたオープンソースフレームワークであり、単一のコードベースからモバイル、デスクトップ、またはWebブラウザ向けにネイティブコンパイルされたクロスプラットフォームアプリケーションを開発するために使用されます。Flutterでは、アプリを構築する単一のプライマリOSであるプライマリ開発ターゲットを選択できます。 Catalyst Flutter SDKは、Flutterの以下のサポートされているモバイル開発ターゲット向けに、Catalystプロジェクトのモバイルアプリを構築できるライブラリです： * **Android** * **iOS** Catalyst Flutter SDKパッケージには、強力なバックエンドを備えた動的で堅牢なモバイルアプリの開発を支援するさまざまなツールと機能が含まれています。これにより、さまざまなCatalystサービスおよびコンポーネントのバックエンド処理を扱うことができます。Flutter SDKは、CatalystネイティブのAndroid SDKおよびiOS SDKでサポートされているすべての機能をサポートしています。 Flutter SDKには、主にユーザー認証とリダイレクト、Data StoreおよびFile Storeの機能、関数の実行など、Catalyst Cloud ScaleおよびCatalyst Serverlessの機能に関するツールが含まれています。ユーザー、Data Storeの行や列などのCatalystエンティティは、データモデリングを通じてDartオブジェクトとしてモデル化されます。Flutter SDKは、これらのコンポーネントへのAPIリクエストをメソッド呼び出しとしてラップしており、利用することができます。 SDKパッケージが提供するすぐに使える機能を実装することで、これらのCatalystコンポーネントをモバイルアプリにシームレスに統合し、簡単に構築できます。これにより、バックエンドをゼロからコーディングする時間と労力を節約し、アプリのユーザーエクスペリエンスの設計により集中できます。 このドキュメントでは、Catalyst Flutter SDKを使用してモバイルアプリをセットアップし構築するプロセス全体を説明します。SDKパッケージの設定について学び、さまざまな操作のサンプルコードスニペットにアクセスできます。また、Android向けのFlutterの公式ガイドやiOS向けの公式ガイドも参照し、プライマリターゲットとしてそれらの開発プラットフォームを使用してアプリを構築できます。 AndroidまたはiOSでFlutterアプリを開発した後、いずれかまたは両方のプラットフォームでアプリのビルドをデプロイし、Catalystでホストできます。AndroidアプリのデプロイおよびiOSアプリのデプロイに関するFlutterの公式ガイドを参照してください。 Note: Mobile Device Managementを使用してアプリをホストおよび配布できます。また、Catalystコンソールからアプリのバージョニングやエンドユーザーを簡単に管理できます。iOSでアプリを構築し、プッシュ通知の送信を有効にしている場合は、アプリにPush Notificationsを設定することもできます。ただし、Push NotificationsおよびMobile Device Managementは、現在EU、AU、IN、またはCAデータセンターからアクセスしているCatalystユーザーには利用できません。 -------------------------------------------------------------------------------- title: "クラス階層" description: "クラス階層は、Catalyst Flutter SDKにおけるクラスの階層構造を示します。" last_updated: "2026-06-10T06:04:54.118Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/class-hierarchy/" service: "All Services" related: - Authentication (/ja/cloud-scale/help/mobile-device-management/introduction) - Data Store (/ja/cloud-scale/help/data-store/introduction) - File Store (/ja/cloud-scale/help/file-store/introduction) - Search (/ja/cloud-scale/help/search-integration/introduction/) - Functions (/ja/serverless/help/functions/introduction) - ZCQL (/ja/cloud-scale/help/zcql/introduction) -------------------------------------------------------------------------------- # クラス階層 ### はじめに Flutter SDKのすべてのCatalystコンポーネントエンティティは、Dartオブジェクトとしてモデル化されています。これらのコンポーネントクラスのメンバーとメソッドは、コンポーネントの動作を定義し、コンポーネントでさまざまな操作を実行できるようにします。 Catalyst Flutter SDKパッケージには、さまざまなCatalystサービスの以下のCatalystコンポーネントおよび機能と連携するためのツールが含まれています： * **General:** Timezone * **Serverless:** Functions * **Cloud Scale:** Authentication、Data Store、File Store、Search、ZCQL Catalyst Flutter SDKコンポーネントクラスの階層は、以下のアーキテクチャ図に示されています。 **ZCatalystApp**は、Catalyst Flutter SDKの基本クラスです。SDKを初期化し、Catalystプロジェクトのさまざまなコンポーネントにアクセスするための複数のメソッドで構成されています。その他のクラスは、SDKでサポートされている各コンポーネントとその固有の機能に対応しています。 <br> ### インスタンスオブジェクト ZCatalystAppの配下にある各クラスには、API呼び出しを実行して直接の子エンティティのプロパティやデータを取得する関数が含まれています。 ただし、下位レベルのコンポーネントのデータを取得するために、常にクラス階層を最上位まで辿ることは効率的ではありません。そのような操作は各レベルでAPI呼び出しを伴うため、アプリケーションの使用が非効率になります。この状況を回避し、アプリをよりコスト効率の高いものにするために、Catalystはすべてのクラスにインスタンスオブジェクトを提供しています。 **インスタンスオブジェクト**は各コンポーネントクラスに存在し、**getInstance()**メソッドを通じてアクセスできます。このメソッドはコンポーネントのダミーオブジェクトを取得し、そのオブジェクトを使用してすべての子エンティティのメソッドを取得できます。 したがって、Catalystコンポーネントのプロパティを取得するには、コンポーネントのオブジェクトをそのgetInstance()メソッドで呼び出す必要があります。その後、同じオブジェクトを使用して、コンポーネントが定義する他のメソッドを呼び出してください。これにより、不要で過剰なAPI呼び出しを防ぐことができます。 -------------------------------------------------------------------------------- title: "例外処理" description: "このヘルプページでは、Flutter SDKで構築されたCatalyst AndroidおよびiOSアプリの実行時に発生する一般的な例外を一覧で示します。" last_updated: "2026-06-10T06:04:54.118Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/exceptions/" service: "All Services" related: - Developer Tools (/ja/getting-started/set-up-a-catalyst-project/developer-tools) -------------------------------------------------------------------------------- # 例外処理 例外処理は、アプリの実行中に発生する予期しない不具合の動作です。Flutter SDKで構築されたAndroidまたはiOSアプリのすべてのエラーと例外は、Android SDKパッケージで定義されたZCatalystExceptionという列挙型によって処理されます。 モバイルアプリで例外が発生した場合、例外の以下のDartプロパティが返されます： * code: エラーの一意の識別子 * errorMsg: エラーに関する一般的な説明 * errorDetails: エラーに関する追加情報 * originalException: スローされた実際の例外 Catalyst Flutter SDKがスローする一般的なエラーコードとその説明を以下に示します： <table class="content-table"> <thead> <tr> <th class="w30p">エラーコード</th> <th class="w70p">説明</th> </tr> </thead> <tbody> <tr> <td><strong>INITIALIZATION_ERROR</strong></td> <td>SDKの初期化に失敗しました</td> </tr> <tr> <td><strong>LOGIN_ERROR</strong></td> <td>ユーザーのログインプロセスに失敗しました</td> </tr> <tr> <td><strong>LOGOUT_FAILED</strong></td> <td>ユーザーのログアウトプロセスに失敗しました</td> </tr> <tr> <td><strong>TOKEN_FETCH_ERROR</strong></td> <td>アクセストークンの取得に失敗しました</td> </tr> <tr> <td><strong>RESPONSE_PARSE_ERROR</strong></td> <td>受信したレスポンスをパースできません</td> </tr> <tr> <td><strong>NO_NETWORK_AVAILABLE</strong></td> <td>API呼び出しを行うためのネットワーク接続が利用できません</td> </tr> <tr> <td><strong>API_FAILED</strong></td> <td>APIの呼び出しに失敗しました</td> </tr> <tr> <td><strong>INVALID_DATA</strong></td> <td>送信されたデータが特定のフォーマットに対して有効な型ではありません</td> </tr> <tr> <td><strong>FILE_SIZE_EXCEEDED</strong></td> <td>アップロードされたファイルのサイズが100MBのファイルサイズ制限を超えています</td> </tr> <tr> <td><strong>FUNCTION_EXECUTION_ERROR</strong></td> <td>関数の実行に失敗しました</td> </tr> <tr> <td><strong>JSON_EXCEPTION</strong></td> <td>リクエストに含まれるボディが有効なJSONではありません</td> </tr> <tr> <td><strong>INVALID_REQUEST</strong></td> <td>作成されたリクエストが有効ではありません</td> </tr> <tr> <td><strong>INVALID_FILE_INPUT</strong></td> <td>アップロード操作で送信されたファイルが有効ではありません</td> </tr> <tr> <td><strong>INTERNAL_ERROR</strong></td> <td>SDKで内部エラーが発生しました</td> </tr> <tr> <td><strong>INVALID_CONFIGURATION</strong></td> <td>ログインに必要な設定でSDKが初期化されていません。適切な設定でSDKを再初期化してください。</td> </tr> <tr> <td><strong>CUSTOM_LOGIN_DISABLED</strong></td> <td>サードパーティ認証に必要なパラメーターが見つかりませんでした。プロジェクトでサードパーティ認証を有効にしているか確認するか、プロパティファイルを再ダウンロードしてください。</td> </tr> </tbody> </table> <br> ### iOSアプリの例外 iOSアプリでエラーが発生した場合、エラーの以下のプロパティが返されます： * **code**: エラーの一意の識別子 * **message**: エラーに関する一般的な説明 * **details**: エラーに関する追加情報 Catalyst iOS SDKがスローする一般的なエラーコードとその説明を以下に示します： <table class="content-table"> <thead> <tr> <th class="w30p">エラーコード</th> <th class="w70p">説明</th> </tr> </thead> <tbody> <tr> <td><strong>INVALID_DATA</strong></td> <td>データが無効なフォーマットです</td> </tr> <tr> <td><strong>INTERNAL_ERROR</strong></td> <td>内部の問題、サーバー、またはその他の原因によりエラーが発生しました</td> </tr> <tr> <td><strong>RESPONSE_NIL</strong></td> <td>サーバーからレスポンスが返されませんでした</td> </tr> <tr> <td><strong>TOKEN_FETCH_ERROR</strong></td> <td>アクセストークンの取得に失敗しました</td> </tr> <tr> <td><strong>OAUTH_FETCH_ERROR</strong></td> <td>OAUTHトークンの取得中にエラーが発生しました</td> </tr> <tr> <td><strong>UNABLE_TO_CONSTRUCT_URL</strong></td> <td>URLの構築中にエラーが発生しました</td> </tr> <tr> <td><strong>PROCESSING_ERROR</strong></td> <td>データの処理中にエラーが発生しました</td> </tr> <tr> <td><strong>TYPECAST_ERROR</strong></td> <td>データの型キャスト中にエラーが発生しました</td> </tr> <tr> <td><strong>NO_INTERNET_CONNECTION</strong></td> <td>デバイスがインターネットに接続されていません</td> </tr> <tr> <td><strong>REQUEST_TIMEOUT</strong></td> <td>サーバーからのレスポンスが時間内に届きませんでした</td> </tr> <tr> <td><strong>NETWORK_CONNECTION_LOST</strong></td> <td>デバイスのインターネット接続が切断されました</td> </tr> <tr> <td><strong>INITIALIZATION_ERROR</strong></td> <td>SDKの初期化中にエラーが発生しました</td> </tr> <tr> <td><strong>FUNCTION_EXECUTION_ERROR</strong></td> <td>関数の実行中にエラーが発生しました</td> </tr> <tr> <td><strong>JSON_EXCEPTION</strong></td> <td>JSONのパース中にエラーが発生しました</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "前提条件" description: "このページでは、Catalyst Flutter SDKを使用するために満たす必要のある前提条件を説明します。" last_updated: "2026-06-10T06:04:54.119Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/prerequisites/" service: "All Services" related: - Create Catalyst Projects (/ja/getting-started/catalyst-projects) -------------------------------------------------------------------------------- # 前提条件 Catalyst Flutter SDKの使用を開始する前に、以下の前提条件を満たしていることを確認してください： 1. **Catalystプロジェクトの作成:** モバイルアプリをホストするために、CatalystコンソールでCatalystプロジェクトを作成する必要があります。 Note: 各プロジェクトには、1つのAndroidアプリと1つのiOSアプリをホストできます。AndroidまたはiOSアプリは、CatalystのAndroidまたはiOS SDKを使用してネイティブに構築するか、Flutter SDKを使用して構築できます。 <br> 2. **IDEのインストール:** 選択する開発ターゲットに応じて、サポートされているIDEまたはエディタをインストールする必要があります。Flutter SDK、拡張機能、プラグインとの連携をサポートするIDEおよびそのバージョンをインストールしてください。サポートされている選択肢は、Android Studio、IntelliJ IDEA、Visual Studio Codeです。 Note: Flutterプラグインは、これら以外のIDEでは動作しません。iOSアプリの場合、これらのサポートされているIDEのいずれかを使用してアプリを開発し、その後XcodeにインポートしてiOSアプリのビルドとデプロイを行うことができます。 AndroidおよびiOSの最小サポート環境は、以下のセクションに記載されています。 <br> 3. **Flutter SDKのインストール:** お使いのシステムのOS向けに以下をインストールする必要があります： * Flutter SDK * 要件に応じた必要なライブラリ、プラグイン、または拡張機能 * プラットフォーム固有のソフトウェアおよびSDK お使いのシステムOSに基づいたFlutterのインストールについては、こちらを参照してください：Windows、macOS、Linux、ChromeOS。 -------------------------------------------------------------------------------- title: "Androidの開始手順" description: "Androidをプライマリ開発ターゲットとしてFlutterモバイルアプリを構築するには、CatalystでAndroidアプリの開発に必要な環境をセットアップする必要があります。" last_updated: "2026-06-10T06:04:54.119Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/setup-for-android/" service: "All Services" related: - Environments (/ja/deployment-and-billing/environments/introduction/#introduction) - Developer Tools (/ja/deployment-and-billing/environments/introduction/#introduction) - Android SDK (/ja/sdk/android/v2/overview/) -------------------------------------------------------------------------------- # Androidの開始手順 Flutter SDKを使用してAndroidをプライマリ開発ターゲットとしてFlutterモバイルアプリケーションを構築するには、CatalystでAndroidアプリの開発に必要な環境をセットアップする必要があります。 ### 前提条件と最小サポート環境 Androidプラットフォームでのflutterアプリの作業を開始する前に、以下の前提条件を満たし、最小サポート環境を設定していることを確認してください： * Android Studioまたはサポートされている任意のIDEでFlutterプロジェクトを作成してください * Androidプロジェクトが以下の最小サポート環境を満たしていることを確認してください： * OS- Android API Level 21 (Lollipop 4.4) * Kotlin- 1.3.20 * Gradle- 3.4.0 * IDEでアプリを実行するためのデバイスまたはエミュレーターをセットアップしてください Catalystにアプリを登録し、アプリに合わせてカスタマイズされた設定ファイルをダウンロードできます。この設定ファイルには、アプリが正常に機能するために必要な特定のプロパティの定義が含まれているため、Androidアプリの構造に含める必要があります。 <br> ## セットアップ FlutterおよびAndroidのセットアップの前提条件を満たした後、以下の手順に従ってAndroidパッケージをアプリにセットアップおよび統合してください。 ### ステップ1：CatalystにAndroidアプリを登録する まず、CatalystでAndroidアプリ用のパッケージを作成して登録し、固有の設定ファイルをダウンロードします。 1. プロジェクトのCatalystコンソールから設定アイコンをクリックします。 2. 設定メニューのProject Settings配下にある**Developer Tools**に移動し、**Android**タイルをクリックします。 または、下の**Add Package**ボタンをクリックすることもできます。 <br /> 3. 一意に識別できるパッケージ名を入力します。エンドユーザーがアプリにログインした後にリダイレクトするURLをRedirect URLとして指定します。 ここで入力した値は、設定ファイルに自動入力されます。 Note: パッケージ名はそのOSに一意に関連付けられます。そのため、AndroidアプリとiOSアプリの両方に同じ名前のパッケージを作成することはできません。一意の値を指定する必要があります。 OSタイプとしてAndroidが選択されていることを確認してください。 <br /> 4. **Create**をクリックしてモバイルSDKパッケージを作成します。 5. コンソールに設定ファイルをダウンロードできるウィンドウが表示されます。**Download**をクリックしてファイルをダウンロードします。 必要なすべての設定が含まれたファイルがダウンロードされます。このファイルのプロパティについては、次のステップで説明します。 <br /> ### ステップ2：AndroidプロジェクトにConfiguration Fileをインポートする Catalystは、アプリケーションの開発およびビルド用に、**Development**サンドボックスとライブの**Production**環境の2つの作業環境を提供しています。詳細については、Environmentsヘルプページを参照してください。 コンソールでパッケージを作成すると、現在作業している環境に関係なく、最初はDevelopment環境の設定ファイルのみがダウンロード可能になります。パッケージが作成された後であれば、いつでもコンソールから任意の環境の設定ファイルをダウンロードできます。 各環境の設定ファイル名は以下の通りです： * Development: **app_configuration_development.properties** * Production: **app_configuration_production.properties** 作業している環境に基づいて、適切なファイルをダウンロードしてAndroidアプリの構造に追加する必要があります。Production環境の設定ファイルを取得するには、まずプロジェクトをProductionにデプロイしてから、Developer Tools設定セクションからファイルをダウンロードしてください。 設定ファイルは、Androidアプリモジュールの**assets**ディレクトリに追加する必要があります。通常、assetsフォルダはapp/src/mainディレクトリに作成されます。 Androidアプリモジュールの詳細については、Android公式ドキュメントを参照してください。 <br /> #### app_configuration_development.properties/ app_configuration_production.propertiesファイルのプロパティ アプリ設定ファイルは、以下の表に記載されたプロパティを定義します。リクエストヘッダーを除くすべての値は、プロジェクトの詳細またはデフォルトの標準に基づいて自動的に入力されます。 Note: これらの値の取得先については、表に記載されたリンクを参照してください。 <table class="content-table"> <thead> <tr> <th class="w20p">プロパティ</th> <th class="w20p">データ型</th> <th class="w60p">説明</th> </tr> </thead> <tbody> <tr> <td>**clientID**</td> <td>String</td> <td>Catalystに登録されたアプリクライアントの一意の識別子です。設定ファイルで提供されます。</td> </tr> <tr> <td>**clientSecret**</td> <td>String</td> <td>特定のclientIDに対して生成されたシークレット値で、APIリクエストとともに渡されます。設定ファイルで提供されます。</td> </tr> <tr> <td>**portalID**</td> <td>String</td> <td>設定ファイルで提供される一意の識別子です</td> </tr> <tr> <td>**redirectUrl**</td> <td>String</td> <td>前のステップでコンソールでパッケージを作成する際に指定した、アプリのコールバックURLです</td> </tr> <tr> <td>**projectID**</td> <td>Long</td> <td>Catalystプロジェクトの一意のIDです</td> </tr> <tr> <td>**apiBaseURL**</td> <td>String</td> <td>内部APIが呼び出されるCatalystサーバーのURLです。作業している環境に基づいて、適切なURL（Development URLまたはProduction URL）を使用してください。</td> </tr> <tr> <td>**oauthScopes**</td> <td>String</td> <td>プロジェクトからCatalyst APIにアクセスするためにアプリが使用するスコープです。利用可能なOAuthスコープはこちらで確認できます。</td> </tr> <tr> <td>**requestHeaders**</td> <td>String</td> <td>HTTPリクエストでクライアントが送信するヘッダーです<br /> リクエストヘッダーの値は、コンマで区切られた個別のキーバリューペアで指定する必要があります：requestHeaders=key1:value1, key2:value2</td> </tr> <tr> <td>**serverTLD**</td> <td>String</td> <td>データサーバーのトップレベルドメインです<br /> 許容値：**AU**、**CN**、**COM**、**EU**、**IN**</td> </tr> <tr> <td>**printStackTrace**</td> <td>Boolean</td> <td>**printStackTrace**の値が「true」に設定されている場合、ログの詳細なトレースを取得できます。デフォルト値は「false」です。</td> </tr> <tr> <td>**minLogLevel**</td> <td>String</td> <td>アプリのログ設定を行えます<br /> 許容値：**warnings**、**errors**、**information**、**debug**、**ALL**</td> </tr> <tr> <td>**httpRequestMode**</td> <td>String</td> <td>HTTPリクエストが同期か非同期かを定義します<br /> 許容値：**SYNC**、**ASYNC**<br /> デフォルト値：ASYNC</td> </tr> <tr> <td>**connectTimeOut<br>InSec**</td> <td>Long</td> <td>SDKから送信されるHTTPリクエストの接続タイムアウト値（秒単位）です<br /> つまり、この時間内にサーバーからクライアントリクエストへのレスポンスが受信されない場合、接続が終了します</td> </tr> <tr> <td>**readTimeOutInSec**</td> <td>Long</td> <td>SDKから送信されるHTTPリクエストの読み取りタイムアウト値（秒単位）です<br /> つまり、この時間内にサーバーからデータが受信されない場合、接続が終了します</td> </tr> <tr> <td>**writeTimeOutInSec**</td> <td>Long</td> <td>SDKから送信されるHTTPリクエストの書き込みタイムアウト値（秒単位）です<br /> つまり、この時間内にリクエストデータのサーバーへの書き込みまたは送信に失敗した場合、接続が終了します</td> </tr> <tr> <td>**JWTClientID**</td> <td>String</td> <td>クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントIDプロパティです</td> </tr> <tr> <td>**JWTClientSecret**</td> <td>String</td> <td>クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントシークレットプロパティです</td> </tr> </tbody> </table> Note:<br /> * 設定ファイルの**clientID**、**clientSecret**、**projectID**、または**portalID**の値を変更すると、SDKおよびAndroidアプリの機能に影響します。これらの設定を変更する場合は、Developer Toolsセクションから必要なプロジェクトの新しいパッケージを作成し、適切な環境の新しい設定ファイルをダウンロードして、アプリの構造のassetsディレクトリに追加してください。 * ダウンロードした設定ファイルに入力されたプロパティの値は、**ZCatalystApp.configs**オブジェクトを使用して動的にアクセスできます。 <br /> ### ステップ3：アプリのログインリダイレクトを設定する ユーザーがアプリに正常にログインすると、アプリのホーム画面にリダイレクトされます。このユーザーログインとリダイレクトは、Catalyst SDKによって処理されます。 このリダイレクトが正しく処理されるようにするには、以下のURLスキーマをAndroidアプリのstrings.xmlファイルに含めてください： &lt;string name="url_scheme"&gt;{redirection_url}&lt;/string&gt; strings.xmlファイルは、Androidプロジェクトを作成すると自動的に作成されます。アプリの構造でapp/src/main/res/valuesに移動すると見つけることができます。ファイルにはアプリ名の文字列定義が既に含まれています。この文字列をそれに追加してください。 Catalystでアプリのパッケージを作成する際に設定した**Redirection URL**を、このコードのredirection_urlの代わりに渡す必要があります。 <br /> ### ステップ4：必要な権限を設定する Catalyst SDKは、アプリがシームレスに機能し、スムーズなユーザーエクスペリエンスを提供するために、以下のアプリ権限を有効にする必要があります： * **INTERNET**: Catalyst APIを実行するため * **ACCESS_NETWORK_STATE**: ネットワーク障害を処理するため これらの権限を有効にするには、以下に示すように**AndroidManifest.xml**ファイルで宣言する必要があります： &lt;uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/&gt; &lt;uses-permission android:name="android.permission.INTERNET"/&gt; AndroidManifest.xmlファイルは、アプリの構造でapp/src/mainに移動すると見つけることができます。 <br /> Androidをプライマリ開発ターゲットとしたFlutterアプリの構築のセットアップが完了しました。これで、アプリへのCatalyst Flutter SDKの実装に進むことができます。 -------------------------------------------------------------------------------- title: "iOSの開始手順" description: "iOSをプライマリ開発ターゲットとしてFlutterモバイルアプリを構築するには、CatalystでiOSアプリの開発に必要な環境をセットアップする必要があります。" last_updated: "2026-06-10T06:04:54.120Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/setup-for-ios/" service: "All Services" related: - Environments (/ja/deployment-and-billing/environments/introduction/#introduction) - Developer Tools (/ja/getting-started/set-up-a-catalyst-project/developer-tools) - iOS SDK (/ja/sdk/ios/v2/overview/) -------------------------------------------------------------------------------- # iOSの開始手順 Flutter SDKを使用してiOSをプライマリ開発ターゲットとしてFlutterモバイルアプリケーションを構築するには、CatalystでiOSアプリの開発に必要な環境をセットアップする必要があります。 ### 前提条件と最小サポート環境 iOSプラットフォームでのFlutterアプリの作業を開始する前に、以下の前提条件を満たし、最小サポート環境を設定していることを確認してください： * サポートされている任意のIDEまたはターミナルからFlutterプロジェクトを作成してください * iOSプロジェクトが以下の最小サポート環境を満たしていることを確認してください： * CocoaPods * iOS- 9以降 * Swift- 4以降 * IDEでアプリを実行するためのデバイスまたはエミュレーターをセットアップしてください Catalystにアプリを登録し、アプリに合わせてカスタマイズされた設定ファイルをダウンロードできます。この設定ファイルには、アプリが正常に機能するために必要な特定のプロパティの定義が含まれているため、iOSアプリの構造に含める必要があります。 <br> ## セットアップ Catalystプロジェクトとiosプロジェクトを作成した後、以下の手順に従ってiOS SDKパッケージをアプリにセットアップおよび統合してください。 ### ステップ1：CatalystにiOSアプリを登録する まず、CatalystでiOSアプリ用のパッケージを作成して登録し、固有の設定ファイルをダウンロードします。 1. プロジェクトのCatalystコンソールから**設定アイコン**をクリックします。 2. 設定メニューのProject Settings配下にある**Developer Tools**に移動し、**iOS**タイルをクリックします。 または、下の**Add Package**ボタンをクリックすることもできます。 3. 一意に識別できるパッケージ名を入力します。エンドユーザーがアプリにログインした後にリダイレクトするURLをRedirect URLとして指定します。 ここで入力した値は、設定ファイルに自動入力されます。 Note: パッケージ名はそのOSに一意に関連付けられます。そのため、AndroidアプリとiOSアプリの両方に同じ名前のパッケージを作成することはできません。一意の値を指定する必要があります。 OSタイプとしてiOSが選択されていることを確認してください。 4. **Create**をクリックしてモバイルSDKパッケージを作成します。 5. コンソールに設定ファイルをダウンロードできるウィンドウが表示されます。**Download**をクリックしてファイルをダウンロードします。 必要なすべての設定が含まれたファイルがダウンロードされます。このファイルのプロパティについては、次のステップで説明します。 <br> ### ステップ2：iOSプロジェクトにConfiguration Fileをインポートする Catalystは、アプリケーションの開発およびビルド用に、**Development**サンドボックスとライブの**Production**環境の2つの作業環境を提供しています。詳細については、Environmentsヘルプページを参照してください。 コンソールでパッケージを作成すると、現在作業している環境に関係なく、最初はDevelopment環境の設定ファイルのみがダウンロード可能になります。パッケージが作成された後であれば、いつでもコンソールから任意の環境の設定ファイルをダウンロードできます。 各環境の設定ファイル名は以下の通りです： * Development: **AppConfigurationDevelopment.plist** * Production: **AppConfigurationProduction.plist** 作業している環境に基づいて、適切なファイルをダウンロードしてiOSプロジェクトの**Targets** -> **Runner**に追加する必要があります。Production環境の設定ファイルを取得するには、まずプロジェクトをProductionにデプロイしてから、Developer Tools設定セクションからファイルをダウンロードしてください。 設定ファイルは、iOSプロジェクトの**Targets** -> **Runner**に追加する必要があります。 iOSプロジェクト構造の詳細については、iOS公式ドキュメントを参照してください。 #### AppConfigurationDevelopment.plist/ AppConfigurationProduction.plistファイルのプロパティ アプリ設定ファイルは、以下の表に記載されたプロパティを定義します。リクエストヘッダーを除くすべての値は、プロジェクトの詳細またはデフォルトの標準に基づいて自動的に入力されます。 Note: これらの値の取得先については、表に記載されたリンクを参照してください。 <table class="content-table"> <thead> <tr> <th class="w20p">プロパティ</th> <th class="w20p">データ型</th> <th class="w20p">説明</th> </tr> </thead> <tbody> <tr> <td>**ClientID**</td> <td>String</td> <td>Catalystに登録されたアプリクライアントの一意の識別子です。設定ファイルで提供されます。</td> </tr> <tr> <td>**ClientSecretID**</td> <td>String</td> <td>特定のclientIDに対して生成されたシークレット値で、APIリクエストとともに渡されます。設定ファイルで提供されます。</td> </tr> <tr> <td>**PortalID**</td> <td>String</td> <td>設定ファイルで提供される一意の識別子です</td> </tr> <tr> <td>**RedirectURLScheme**</td> <td>String</td> <td>前のステップでコンソールでパッケージを作成する際に指定した、アプリのコールバックURLです</td> </tr> <tr> <td>**ProjectID**</td> <td>Long</td> <td>Catalystプロジェクトの一意のIDです</td> </tr> <tr> <td>**APIBaseURL**</td> <td>String</td> <td>内部APIが呼び出されるCatalystサーバーのURLです。作業している環境に基づいて、適切なURL（Development URLまたはProduction URL）を使用してください。</td> </tr> <tr> <td>**APIVersion**</td> <td>String</td> <td>APIのバージョンです</td> </tr> <tr> <td>**OauthScopes**</td> <td>String</td> <td>プロジェクトからCatalyst APIにアクセスするためにアプリが使用するスコープです。利用可能なOAuthスコープはこちらで確認できます。</td> </tr> <tr> <td>**RequestHeaders**</td> <td>String</td> <td>HTTPリクエストでクライアントが送信するヘッダーです<br /> リクエストヘッダーの値は、コンマで区切られた個別のキーバリューペアで指定する必要があります：requestHeaders=key1:value1, key2:value2</td> </tr> <tr> <td>**ServerTLD**</td> <td>String</td> <td>データサーバーのトップレベルドメインです<br /> 許容値：**AU**、**CN**、**COM**、**EU**、**IN**</td> </tr> <tr> <td>**MinLogLevel**</td> <td>String</td> <td>アプリのログ設定を行えます<br /> 許容値：**warnings**、**errors**、**information**、**debug**、**ALL**</td> </tr> <tr> <td>**TurnLoggerOn**</td> <td>Boolean</td> <td>値に基づいてロガーをオンにします<br /> 許容値：**true**、**false**</td> </tr> <tr> <td>**RequestTimeOut**</td> <td>Double</td> <td>追加データの到着を待機してからタイムアウトするまでの時間（秒単位）です</td> </tr> <tr> <td>**JWTClientID**</td> <td>String</td> <td>クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントIDプロパティです</td> </tr> <tr> <td>**JWTClientSecret**</td> <td>String</td> <td>クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントシークレットプロパティです</td> </tr> </tbody> </table> Note:<br /> * 設定ファイルの**clientID**、**clientSecretID**、**projectID**、または**portalID**の値を変更すると、SDKおよびiOSアプリの機能に影響します。これらの設定を変更する場合は、Developer Toolsセクションから必要なプロジェクトの新しいパッケージを作成し、適切な環境の新しい設定ファイルをダウンロードして、iOSプロジェクトに追加してください。 * ダウンロードした設定ファイルに入力されたプロパティの値は、**ZCatalystApp.configs**オブジェクトを使用して動的にアクセスできます。 <br> ### ステップ3：アプリのログインリダイレクトを設定する ユーザーがアプリに正常にログインすると、アプリのホーム画面にリダイレクトされます。このユーザーログインとリダイレクトは、Catalyst SDKによって処理されます。 このリダイレクトが正しく処理されるようにするには、以下のキーを同じ設定でiOSプロジェクトの**info.plist**ファイルに含めてください： Key - **URL Types** -----> **URL Schemes**<br /> Type - String<br /> Value - Catalystでアプリのパッケージを作成する際に設定したRedirect URL <br> iOSをプライマリ開発ターゲットとしたFlutterアプリの構築のセットアップが完了しました。これで、アプリへのCatalyst Flutter SDKの実装に進むことができます。 -------------------------------------------------------------------------------- title: "Flutter SDKの実装" description: "AndroidまたはiOSでFlutterアプリの開発環境をセットアップした後、プロジェクトにFlutter SDKをインストール、インポート、および初期化する必要があります。" last_updated: "2026-06-10T06:04:54.120Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/implement-flutter-sdk/" service: "All Services" related: - Environments (/ja/deployment-and-billing/environments/introduction/#introduction) -------------------------------------------------------------------------------- # プロジェクトへのFlutter SDKの実装 AndroidまたはiOSでFlutterアプリの開発環境をセットアップし、IDEでFlutterプロジェクトを作成した後、FlutterプロジェクトにCatalyst Flutter SDKを実装できます。 Flutterプロジェクトを作成すると、基本的なpubspec.yamlファイルが生成され、プロジェクトツリーの最上位に配置されます。このファイルには、プロジェクトに関するメタデータとプロジェクトが必要とする依存関係が含まれています。 ### SDKのインストール Catalyst Flutter SDKを実装するには、Flutterプロジェクトのpubspec.yamlに以下の設定を追加する必要があります： dependencies: zcatalyst_sdk: ^2.2.1 プロジェクトにFlutter SDKをインストールするには、IDEのターミナルから以下のコマンドを実行する必要があります： flutter pub get Note: IDEで以下の方法でもこのパッケージを取得できます： * VS Code: pubspec.yamlの上部にあるアクションリボンの右側にある、ダウンロードアイコンで示された**Get Packages**をクリックします。 * Android Studio/IntelliJ: pubspec.yamlの上部にあるアクションリボンの**Pub get**をクリックします。 <br> #### SDKをインストールする別の方法： 上記のpubspec.yamlファイルに設定を追加する代わりに、FlutterプロジェクトのディレクトリでIDEのターミナルから以下のコマンドを直接実行して、Flutter SDKをインストールできます： flutter pub add zcatalyst_sdk <br> ### SDKのインポート DartコードでSDKをインポートするには、Flutterプロジェクトディレクトリのlib/main.dartファイルに以下のコード行を追加する必要があります： import 'package:zcatalyst_sdk/zcatalyst_sdk.dart'; ### SDKの初期化 SDKパッケージで定義されたメソッドと機能を有効にするために、Catalyst SDKを初期化する必要があります。 そのため、SDKメソッドを使用するようにアプリを設定する前に、以下のいずれかの方法でmain()関数内のZCatalystApp.init()メソッドを使用してSDKを初期化する必要があります： #### 1. Catalyst Configuration Fileを使用する方法： 以前にAndroidまたはiOS用にダウンロードした設定ファイルは、アプリの環境を示します。アプリのプロジェクトの環境に基づいて適切な設定ファイル（Androidの場合はapp_configuration_development.properties / app_configuration_production.properties、iOSの場合はAppConfigurationDevelopment.plist / AppConfigurationProduction.plist）を含めるのと同様に、適切な環境でSDKを初期化する必要があります。 <br> **環境を指定する場合：** この方法では、必要な設定を行い、アプリのenvironmentをDEVELOPMENTまたはPRODUCTIONのいずれかに指定し、以下に示すようにZCatalystAppクラスのinit()メソッドに渡します： ZCatalystApp.init({ ZCatalystEnvironment? environment, }); <br> サンプルコードスニペットを以下に示します： void main() async { try { await ZCatalystApp.init(environment: ZCatalystEnvironment.DEVELOPMENT); } on ZCatalystException catch (ex) { print('Initialized Failed: ${ex.toString()}'); } } <br> **環境を指定しない場合：** SDKの初期化時にenvironmentが指定されない場合、デフォルトでPRODUCTIONとみなされます。そのため、アプリがProduction環境で動作している場合は、以下の方法で直接SDKを初期化できます： await ZCatalystApp.init(); <br> サンプルコードスニペットを以下に示します： void main() async { try { await ZCatalystApp.init(); } on ZCatalystException catch (ex) { print('Initialized Failed: ${ex.toString()}'); } } Note: AndroidまたはiOSの設定ファイルに変更を加えた場合は、SDKを再初期化する必要があります。 <br> #### 2. カスタムSDK Configurationオブジェクトを渡す方法： 別の方法として、ZCatalystSDKConfigsBuilderクラスを使用して渡せるカスタムZCatalystSDKConfigsオブジェクトを構築して、Flutter SDKを初期化できます。 **ZCatalystSDKConfigsオブジェクト** ZCatalystSDKConfigsBuilderクラスには、以下の設定プロパティがあります： <table class="content-table"> <thead> <tr> <th class="w20p">プロパティ</th> <th class="w20p">データ型</th> <th class="w20p">説明</th> </tr> </thead> <tbody> <tr> <td>**environment**</td> <td>ZCatalystEnvironment</td> <td>アプリが現在実行されている環境です</td> </tr> <tr> <td>**apiBaseURL**</td> <td>String</td> <td>内部APIが呼び出されるCatalystサーバーのURLです。作業している環境に基づいて、適切なURL（Development URLまたはProduction URL）を使用してください。</td> </tr> <tr> <td>**clientID**</td> <td>String</td> <td>Catalystに登録されたアプリクライアントの一意の識別子です。設定ファイルで提供されます。</td> </tr> <tr> <td>**clientSecret**</td> <td>String</td> <td>特定のclientIDに対して生成されたシークレット値で、APIリクエストとともに渡されます。設定ファイルで提供されます。</td> </tr> <tr> <td>**projectID**</td> <td>int</td> <td>Catalystプロジェクトの一意のIDです</td> </tr> <tr> <td>**redirectURL**</td> <td>String</td> <td>コンソールでAndroidまたはiOS用のパッケージを作成する際に指定した、アプリのコールバックURLです</td> </tr> <tr> <td>**portalID**</td> <td>String</td> <td>AndroidまたはiOSアプリのセットアップ時に設定ファイルで提供される一意の識別子です</td> </tr> <tr> <td>**oauthScopes**</td> <td>String</td> <td>プロジェクトからCatalyst APIにアクセスするためにアプリが使用するスコープです。利用可能なOAuthスコープはこちらで確認できます。</td> </tr> <tr> <td>**JWTClientID**</td> <td>String</td> <td>クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントIDプロパティです</td> </tr> <tr> <td>**JWTClientSecret**</td> <td>String</td> <td>クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントシークレットプロパティです</td> </tr> </tbody> </table> <br> このZCatalystSDKConfigsオブジェクトは、以下に示すようにZCatalystSDKConfigsBuilderクラスを使用して渡すことができます： ZCatalystSDKConfigs sdkConfigs = ZCatalystSDKConfigsBuilder( apiBaseURL: 'https://api.catalyst.zoho.com', accountsPortalBaseURL: 'https://accounts.zoho.com', clientID: '100****************************FX', clientSecret: '19ed***************************2s', environment: ZCatalystEnvironment.DEVELOPMENT, oauthScopes: 'ZOHOCATALYST.tables.rows.ALL, ZOHOCATALYST.tables.columns.ALL', portalID: '10******79', projectID: 28*******90, redirectURL: '*****') .setUserAgent("ZCatalyst Sample App") .build(); try { await ZCatalystApp.init(sdkConfigs: sdkConfigs); } on ZCatalystException catch (ex) { print('Initialized Failed: ${ex.toString()}'); } SDKが正常に初期化されると、アプリはコンポーネントメソッドを呼び出し、意図した通りに機能します。 #### Cloud Scale ##### Data Store -------------------------------------------------------------------------------- title: "新しいData Storeインスタンスの作成" description: "Flutter SDKでData Storeの機能にアクセスするために、Data Storeのインスタンスを作成できます。" last_updated: "2026-06-10T06:04:54.121Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/data-store/create-data-store-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Data Store - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # Data Store Catalyst Data Storeは、テーブルを通じてアプリケーションの永続的なデータを格納するクラウドベースのリレーショナルデータベース管理システムです。 ### 新しいData Storeインスタンスの作成 CatalystプロジェクトのData Storeにアクセスするには、Data Storeのインスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。これにより、不要なサーバー呼び出しを防ぐことができます。 Data Storeインスタンスを正常に取得するには、以下のコード構文に示すように**getDataStoreInstance()**メソッドを呼び出す必要があります： ZCatalystDataStore dataStore = ZCatalystApp.getInstance().getDataStoreInstance(); -------------------------------------------------------------------------------- title: "新しいテーブルインスタンスの作成" description: "Data Store内の特定のテーブルのテーブルインスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。" last_updated: "2026-06-10T06:04:54.121Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/data-store/create-table-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Tables (/ja/cloud-scale/help/data-store/tables) - Data Store - API (/ja/api/code-reference/cloud-scale/data-store/insert-new-row/#InsertNewRow) -------------------------------------------------------------------------------- # 新しいテーブルインスタンスの作成 Data Store内の特定のテーブルのテーブルインスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。これにより、不要なサーバー呼び出しを防ぐことができます。 テーブルインスタンスは、以下の2つの方法のいずれかで**getTableInstance()**メソッドを呼び出すことで作成できます。 両方のメソッドで使用される&lt;DATA_STORE_INSTANCE&gt;は、Data Storeインスタンスページで定義されたインスタンスです。 ### IDによるテーブルインスタンスの作成 以下のコード構文に示すように、特定のテーブルIDを引数としてgetTableInstance()メソッドに渡すことで、テーブルインスタンスを作成できます： ZCatalystTable &lt;DATA_STORE_INSTANCE&gt;.getTableInstance(String identifier) **パラメーター**: * **identifier**: インスタンスを作成する特定のテーブルの一意のテーブルIDです サンプルコードスニペットを以下に示します： var table = ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance("2823000000017011") <br> ### 名前によるテーブルインスタンスの作成 別の方法として、以下のコード構文に示すように、特定のテーブル名を引数として**getTableInstance()**メソッドに渡すことで、テーブルインスタンスを作成できます： &lt;DATA_STORE_INSTANCE&gt;.getTableInstance( String identifier ) **パラメーター**: * **identifier**: インスタンスを作成する特定のテーブルの名前です サンプルコードスニペットを以下に示します： var table = ZCatalystApp.getInstance().getDataStoreInstance().getTableInstance(identifier: "Products"); -------------------------------------------------------------------------------- title: "カラムメタデータの取得" description: "指定されたインスタンスのData Storeテーブルのすべてのカラムまたは特定の単一カラムのメタデータを、IDまたは名前で取得できます。" last_updated: "2026-06-10T06:04:54.121Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/data-store/get-column-metadata/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Columns (/ja/cloud-scale/help/data-store/columns) - Get Metadata of Coulumns - API (/ja/api/code-reference/cloud-scale/data-store/get-all-columns-metadata/#GetAllColumnsMetadata) -------------------------------------------------------------------------------- # カラムメタデータの取得 ### 特定のカラムのメタデータを取得する **getColumn()** メソッドを呼び出すことで、指定されたインスタンスのData Storeテーブルの特定の単一カラムのメタデータを取得できます。操作が成功した場合、このメソッドはカラムのデータ型、デフォルト値、最大長、読み取り専用かどうか、ユニークかどうか、必須かどうかなどのメタデータを返すことができます。 特定のカラムのメタデータは2つの異なる方法で取得できます。両方のメソッドで使用される&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されたインスタンスです。 #### i. IDによるカラムの取得 以下のコード構文に示すように、カラムIDをString形式でgetColumn()メソッドの引数として渡すことで、特定のカラムのメタデータを取得できます。 Future<(APIResponse, ZCatalystColumn)> &lt;TABLE_INSTANCE&gt;.getColumn(String identifier) **パラメータ**: * **identifier**: 取得する必要がある特定のカラムの一意のカラムID サンプルコードスニペットを以下に示します： try { var (response, column) = await app .getDataStoreInstance() .getTableInstance('Projects') .getColumn('1624000000139101'); print(column.id) } on ZCatalystException catch (ex) { print(ex.toString()); } #### ii. 名前によるカラムの取得 以下のコード構文に示すように、カラムの名前をgetColumn()メソッドの引数として渡すことで、特定のカラムのメタデータを取得できます。 Future<(APIResponse, ZCatalystColumn)> &lt;TABLE_INSTANCE&gt;.getColumn(String identifier) **パラメータ**: * **identifier**: 取得する必要がある特定のカラムの名前 サンプルコードスニペットを以下に示します： try { var (response, column) = await app .getDataStoreInstance() .getTableInstance('Projects') .getColumn('Category'); print(column.id); } on ZCatalystException catch (ex) { print(ex.toString()); } <br> ### すべてのカラムのメタデータを取得する 以下のコード構文に示すように、**getColumns()**メソッドを使用して、指定されたインスタンスのテーブルのすべてのカラムのメタデータを取得できます。操作が成功した場合、このメソッドは特定のテーブルのすべてのカラムのメタデータを返すことができます。 以下のコードで使用される&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されたインスタンスです。 Future<(APIResponse, List&lt;ZCatalystColumn&gt;)> &lt;TABLE_INSTANCE&gt;.getColumns() サンプルコードスニペットを以下に示します： try { var (response, columns) = await app .getDataStoreInstance() .getTableInstance('Projects') .getColumns(); for (var column in columns) { print(column.name); } } on ZCatalystException catch (ex) { print(ex.toString()); } -------------------------------------------------------------------------------- title: "行の取得" description: "指定されたインスタンスのData Storeテーブルから、特定の単一行またはすべての行を取得できます。" last_updated: "2026-06-10T06:04:54.121Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/data-store/get-rows/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Get All Rows - API (/ja/api/code-reference/cloud-scale/data-store/get-all-rows/#GetAllRows) -------------------------------------------------------------------------------- # 行の取得 ### 特定の行を取得する **getRow()**メソッドを使用して、指定されたインスタンスのData Storeテーブルから特定の単一行を取得できます。以下のコード構文に示すように、行の一意のROWIDをこのメソッドの引数として渡します。 以下のコードで使用される&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されたインスタンスです。 Future<(APIResponse, ZCatalystRow)> &lt;TABLE_INSTANCE&gt;.getRow(int id) **パラメータ**: * **id**: 取得する必要がある特定の行の一意のROWID サンプルコードスニペットを以下に示します： try { ZCatalystTable table = app.getDataStoreInstance().getTableInstance('Projects'); var (response, row) = await table.getRow(1624000000139040); print(row.id); } on ZCatalystException catch (ex) { print(ex.toString()); } <br> ### すべての行を取得する 以下のコード構文に示すように、**getRows()**メソッドを使用して、指定されたインスタンスのテーブルのすべての行を取得できます。操作が成功した場合、このメソッドはフィルターや条件なしでテーブルのすべての行を返します。 以下のコード構文で使用される&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されたインスタンスです。 Future<(APIResponse, List)> &lt;TABLE_INSTANCE&gt;.getRows() サンプルコードスニペットを以下に示します： try { var (response, rows, resInfo) = await app .getDataStoreInstance() .getTableInstance('Projects') .getRows(); for (var row in rows) { print(row.getData()); } } on ZCatalystException catch (ex) { print(ex.toString()); } -------------------------------------------------------------------------------- title: "行からカラム値を取得する" description: "Data Storeテーブルの行内の特定のカラムの値を取得できます。" last_updated: "2026-06-10T06:04:54.122Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/data-store/get-column-value-from-row/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Columns (/ja/cloud-scale/help/data-store/columns) - Get Metadata of Columns - API (/ja/api/code-reference/cloud-scale/data-store/get-all-columns-metadata/#GetAllColumnsMetadata) -------------------------------------------------------------------------------- # 行からカラム値を取得する getColumnValue()メソッドを使用して、Data Storeテーブルの行内の特定のカラムの値を取得できます。たとえば、行内の「product_name」という単一カラムの値が必要な場合、このメソッドを使用してその特定の値を取得できます。 サンプルコード構文に示すように、カラムのカラム名をgetColumnValue()メソッドの引数として渡す必要があります。以下に示すように、まず行のインスタンスを取得する必要があります。 以下のコードで使用される&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されたインスタンスです。 dynamic &lt;ROWINSTANCE&gt;.getColumnValue() **パラメータ**: * **id**: 取得する必要がある特定の行の一意のROWID サンプルコードスニペットを以下に示します： var table = dataStore.getTableInstance(identifier: 'Products'); try{ var (response, table) = await table.getRow(id: 2823000000014176) print("quantity: ${row.getColumnValue("quantity")}") } on ZCatalystException catch (ex) { print("GET ROW FAILED: $ex"); } -------------------------------------------------------------------------------- title: "新しい行インスタンスの作成" description: "Data Store内の特定のテーブルに対して新しい行インスタンスを作成できます。" last_updated: "2026-06-10T06:04:54.122Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/data-store/create-row-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Insert Row - API (/ja/api/code-reference/cloud-scale/data-store/insert-new-row/#InsertNewRow) -------------------------------------------------------------------------------- # 新しい行インスタンスの作成 Data Store内の特定のテーブルに対して新しい行インスタンスを作成し、このクラスで定義されたメソッドがインスタンスオブジェクトにアクセスできるようにすることができます。これにより、不要なサーバーコールを防止できます。 以下のコード構文に示すように、**newRow()**メソッドを呼び出すことで行インスタンスを作成できます。 ここで使用される&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されたインスタンスです。 <br /> &lt;TABLE_INSTANCE&gt;.newRow() <br /> サンプルコードスニペットを以下に示します： <br /> var row = ZCatalystApp.getInstance() .getDataStoreInstance() .getTableInstance(identifier: 'Products') .newRow(); -------------------------------------------------------------------------------- title: "行の作成" description: "Data Store内の特定のテーブルに対して新しい行インスタンスを作成し、このクラスで定義されたメソッドがインスタンスオブジェクトにアクセスできるようにすることができます。" last_updated: "2026-06-10T06:04:54.122Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/data-store/create-rows/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Insert Row - API (/ja/api/code-reference/cloud-scale/data-store/insert-new-row/#InsertNewRow) -------------------------------------------------------------------------------- # 行の作成 ### 単一行の作成 **newRow()**メソッドを使用して、指定されたインスタンスのData Storeテーブルに新しい行を作成できます。カラム名と対応する行の値をキーと値のペアとして指定することで、テーブル内の行の値を設定する必要があります。 以下のコード構文で使用される&lt;ROW_INSTANCE&gt;は、行インスタンスページで定義されたインスタンスです。 Future<(APIResponse, ZCatalystRow)> &lt;ROW_INSTANCE&gt;.create() 注意: is_uniqueまたはis_mandatoryプロパティが有効な状態でカラムが作成された場合、値がそれぞれ一意であること、または必須で渡されることを確認する必要があります。また、カラムに渡すデータがカラムに設定されたデータ型であることも確認する必要があります。 行インスタンスの作成を含むサンプルコードスニペットを以下に示します： var row = ZCatalystApp.getInstance() .getDataStoreInstance() .getTableInstance(identifier: 'Products') .newRow(); //テーブルの行インスタンスを定義し、行のキーと値のデータを渡す row.setColumnValue('product_name', 'power_bank'); row.setColumnValue('product_price', 2000); row.setColumnValue('product_quantity', 2); try { var (response, row) = await row.create(); print('New row created successfully : ${row.id}'); } on ZCatalystException catch (ex) { print('Failed to create the row: $exception'); } <br> ### 複数行の作成 Catalyst Flutter SDKでは、指定されたインスタンスのテーブルに複数の行を一度に作成できます。テーブルに挿入する必要がある行を含むリストを渡すことで実行されます。以下のコード構文に示すように、リストは**createRows()**メソッドの引数として渡されます。 以下のコードで使用される&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されたインスタンスです。 Future<(APIResponse, List&lt;ZCatalystRow&gt;)> &lt;TABLE_INSTANCE&gt;.createRows(List&lt;ZCatalystRow&gt; rows) **パラメータ**: * **rows**: 作成する行の配列 行インスタンスの作成を含むサンプルコードスニペットを以下に示します： List&lt;ZCatalystRow&gt; newRows = []; //配列を作成する //作成する行の行インスタンスを定義する ZCatalystRow row1 = dataStore.getTableInstance(identifier: 'Products').newRow(); row1.setColumnValue('product_name', 'a'); row1.setColumnValue('product_price', 25); row1.setColumnValue('product_quantity', 50); ZCatalystRow row2 = dataStore.getTableInstance(identifier: 'Products').newRow(); row2.setColumnValue('product_name', 'b'); row2.setColumnValue('product_price', 30); row2.setColumnValue('product_quantity', 40); ZCatalystRow row3 = dataStore.getTableInstance(identifier: 'Products').newRow(); row3.setColumnValue('product_name', 'c'); row3.setColumnValue('product_price', 25); row3.setColumnValue('product_quantity', 70); //配列に行インスタンスを追加する newRows.add(row1); newRows.add(row2); newRows.add(row3); try{ var (response, rows) = await dataStore.getTableInstance(identifier: 'Products').createRows(rows: newRows); for (var row in rows) { print(row.id); //行の正常な作成時に実行するアクション } } on ZCatalystException catch (ex) { print('The IDs of the rows that were successfully created are listed below:') } -------------------------------------------------------------------------------- title: "行の更新" description: "Data Storeテーブル内の特定の単一行またはすべての行を更新できます。" last_updated: "2026-06-10T06:04:54.122Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/data-store/update-rows/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Rows (/ja/cloud-scale/help/data-store/records) - Update Row - API (/ja/api/code-reference/cloud-scale/data-store/update-row/#UpdateRow) -------------------------------------------------------------------------------- # 行の更新 ### 特定の行を更新する 行インスタンスを取得した後、**update()**メソッドを使用してData Storeテーブル内の特定の単一行を更新できます。これにより、カラムの変更された値をキーと値のペアとしてsetColumnValue()メソッドに渡すことで、行の1つ以上のカラムの値を更新できます。 以下のコード構文で使用される&lt;ROW_INSTANCE&gt;は、行インスタンスページで定義されたインスタンスです。 Future<(APIResponse, ZCatalystRow)> &lt;ROW_INSTANCE&gt;.update() 行インスタンスの取得を含むサンプルコードスニペットを以下に示します： var (response, row) = ZCatalystApp.getInstance() .getDataStoreInstance() .getTableInstance(identifier: 'Products') .getRow(id: 2823000000014176) row.setColumnValue('product_quantity', '100'); //行の変更されたカラム名と値を渡す try { var (response, row) = await row.update(); print('Row updated successfully ${row.getColumnValue('product_quantity')}'); } on ZCatalystException catch (ex) { print('Failed to update the row $exception'); } <br> ### すべての行を更新する 行のリストを**updateRows()**メソッドの引数として渡すことで、テーブル内の複数の行を更新できます。行内で更新する各カラムのキーと値のペアに対して行インスタンスを取得し、setColumnValue()メソッドを通じて変更されたデータを渡す必要があります。次に、以下のコード構文に示すように、行インスタンスを配列に追加し、配列をupdateRows()メソッドの引数として渡すことができます。 以下のコードで使用される&lt;TABLE_INSTANCE&gt;は、テーブルインスタンスページで定義されたインスタンスです。 Future<(APIResponse, List&lt;ZCatalystRow&gt;)> &lt;TABLE_INSTANCE&gt;.updateRows(List&lt;ZCatalystRow&gt; rows) **パラメータ**: * **rows**: 更新する行のリスト 行インスタンスの取得を含むサンプルコードスニペットを以下に示します： List&lt;ZCatalystRow&gt; modifiedRows = []; //配列を作成する var table = ZCatalystApp.getInstance() .getDataStoreInstance() .getTableInstance(identifier: 'Products'); //テーブルインスタンスを作成する try{ var (_, row) = await table.getRow(id: 2823000000014176); row.setColumnValue('product_price', '400'); modifiedRows.add(row); var (_, row) = await table.getRow(id: 2823000000014177); row.setColumnValue('product_price', '90'); modifiedRows.add(row); var (_, row) = await table.getRow(id: 2823000000014178); row.setColumnValue('product_price', '100'); modifiedRows.add(row); var (response, rows) = await table.updateRows(modifiedRows); } on ZCatalystException catch (ex) { print("Failed to update rows: $ex") } -------------------------------------------------------------------------------- title: "行の削除" description: "Catalyst Flutter SDKでは、特定のData Storeテーブルから単一の行を削除できます。" last_updated: "2026-06-10T06:04:54.122Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/data-store/delete-row/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Delete Row - API (/ja/api/code-reference/cloud-scale/data-store/delete-row/#DeleteRow) -------------------------------------------------------------------------------- # 行の削除 Catalyst Flutter SDKでは、特定のData Storeテーブルから単一の行を削除できます。ただし、複数の行を同時に削除することはできません。 行インスタンスを取得し、それをdelete()メソッドに渡すことで、テーブルから行を削除できます。 以下のコード構文で使用される&lt;ROW_INSTANCE&gt;は、行インスタンスページで定義されたインスタンスです。 Future&lt;void&gt; &lt;ROW_INSTANCE&gt;.delete() 行インスタンスの取得を含むサンプルコードスニペットを以下に示します： ZCatalystTable table = app.getDataStoreInstance().getTableInstance('Products'); var (_, row) = await developers.getRow(1624000000139040); await row.delete(); ##### File Store -------------------------------------------------------------------------------- title: "File Storeインスタンスの作成" description: "Catalyst File Storeは、Catalystアプリケーションのアプリデータファイルとユーザーデータファイルのストレージソリューションを提供し、共有データへのアクセスを可能にします。" last_updated: "2026-06-10T06:04:54.122Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/file-store/create-file-store-instance/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - File Store - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder) -------------------------------------------------------------------------------- # File Store 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 Catalyst File Storeは、Catalystアプリケーションのアプリケーションファイルとユーザーデータファイルのクラウドストレージソリューションを提供し、共有データへのアクセスを可能にします。画像、動画、テキストファイル、ドキュメントファイル、スプレッドシート、またはその他の形式のファイルを保存、管理、整理できます。 ### File Storeインスタンスの作成 **getFileStoreInstance()**メソッドを使用して、CatalystプロジェクトのFile Storeのインスタンスを作成し、このクラスで定義されたメソッドがインスタンスオブジェクトにアクセスできるようにすることができます。これにより、不要なサーバーコールを防止できます。 File Storeインスタンスは以下のように作成できます： var fileStore = ZCatalystApp.getInstance().getFileStoreInstance(); -------------------------------------------------------------------------------- title: "フォルダの取得" description: "File Store内の特定のフォルダの詳細を取得できます。" last_updated: "2026-06-10T06:04:54.122Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/file-store/get-folders/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Get Folder - API (/ja/api/code-reference/cloud-scale/file-store/get-all-folders/#GetAllFolders) -------------------------------------------------------------------------------- # フォルダの取得 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 ### 特定のフォルダのメタデータを取得する 以下のコード構文に示すように、一意のフォルダIDを**getFolder()**メソッドの引数として渡すことで、File Store内の特定のフォルダの詳細を取得できます。これにより、フォルダオブジェクトが取得され、フォルダの作成日時、最終更新日時、およびフォルダ内のファイルのメタ情報などのメタデータを取得できます。 以下のコードで使用される&lt;FILE_STORE_INSTANCE&gt;は、File Storeインスタンスページで定義されたインスタンスです。 Future<(APIResponse, ZCatalystFolder)> &lt;FILE_STORE_INSTANCE&gt;.getFolder(int id) **パラメータ**: * **id**: 取得するフォルダの一意のフォルダID File Storeインスタンスを含むサンプルコードスニペットを以下に示します： try{ var (response, folder) = await ZCatalystApp.getInstance().getFileStoreInstance().getFolder(2823000000006561); print('Get Folder Success.'); print('Folder name : ${folder.name}'); } on ZCatalystException catch (ex) { print("Failed to fetch folder: $ex") } <br> ### すべてのフォルダのメタデータを取得する 以下のコード構文に示すように、**getFolders()**メソッドを使用して、プロジェクトのFile Storeで利用可能なすべてのフォルダの詳細を取得できます。これにより、すべてのフォルダおよびフォルダ内のファイルのメタデータを取得できます。 以下のコードで使用される&lt;FILE_STORE_INSTANCE&gt;は、File Storeインスタンスページで定義されたインスタンスです。 Future<(APIResponse, List&lt;ZCatalystFolder&gt;)> &lt;FILE_STORE_INSTANCE&gt;.getFolders() サンプルコードスニペットを以下に示します： try{ var (response, folders) = await ZCatalystApp.getInstance().getFileStoreInstance().getFolders(); print('Get all Folders Success.'); for (var folder in folders) { print(folder.name); } } on ZCatalystException catch (ex) { print("Failed to fetch all folders $ex"); } -------------------------------------------------------------------------------- title: "フォルダインスタンスの作成" description: "File Store内の特定のフォルダのインスタンスを作成し、このクラスで定義されたメソッドがインスタンスオブジェクトにアクセスできるようにすることができます。" last_updated: "2026-06-10T06:04:54.123Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/file-store/create-folder-instance/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - File Store - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder) -------------------------------------------------------------------------------- # フォルダインスタンスの作成 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 **getFolderInstance()**メソッドを使用して、File Store内の特定のフォルダのインスタンスを作成し、このクラスで定義されたメソッドがインスタンスオブジェクトにアクセスできるようにすることができます。以下のコード構文に示すように、そのフォルダのフォルダIDをgetFolderInstance()メソッドに渡す必要があります。 以下のコードで使用される&lt;FILE_STORE_INSTANCE&gt;は、File Storeインスタンスページで定義されたインスタンスです。 &lt;FILE_STORE_INSTANCE&gt;.getFolderInstance( int id ) **パラメータ**: * **id**: インスタンスオブジェクトを返す必要があるフォルダの一意のフォルダID サンプルコードスニペットを以下に示します： ZCatalystFolder folder = ZCatalystApp.getInstance() .getFileStoreInstance() .getFolderInstance(2823000000006561); -------------------------------------------------------------------------------- title: "ファイルの取得" description: "File Store内の特定のファイルまたはすべてのファイルの詳細を取得できます。" last_updated: "2026-06-10T06:04:54.123Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/file-store/get-files/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Get File - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-file/#GetSpecificFile) -------------------------------------------------------------------------------- # ファイルの取得 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 ### 特定のファイルのメタデータを取得する 以下のコード構文に示すように、一意のファイルIDを**getFile()**メソッドの引数として渡すことで、File Store内の特定のファイルの詳細を取得できます。これにより、ファイルオブジェクトが取得され、ファイルの作成日時、最終更新日時、ファイルサイズなどのメタデータを取得できます。 以下のコードで使用される&lt;FOLDER_INSTANCE&gt;は、File Storeインスタンスページで定義されたインスタンスです。 Future<(APIResponse, ZCatalystFile)> &lt;FOLDER_INSTANCE&gt;.getFile(int id) **パラメータ**: * **id**: 取得するファイルの一意のファイルID フォルダインスタンスを含むサンプルコードスニペットを以下に示します： ZCatalystFolder folder = ZCatalystApp.getInstance() .getFileStoreInstance() .getFolderInstance(2823000000006561); try{ var (response, file) = await folder.getFile(2823000000006561); print('Get File Success'); print('The name of the file is : ${file.name}'); print('The size of the file is : ${file.size}'); } on ZCatalystException catch (ex) { print(ex.toString); } <br> ### すべてのファイルのメタデータを取得する 以下のコード構文に示すように、**getFiles()**メソッドを使用して、特定のフォルダ内のすべてのファイルの詳細を取得できます。 以下のコードで使用される&lt;FOLDER_INSTANCE&gt;は、フォルダインスタンスページで定義されたインスタンスです。 Future<(APIResponse, List&lt;ZCatalystFile&gt;)> &lt;FOLDER_INSTANCE&gt;.getFiles() フォルダインスタンスを含むサンプルコードスニペットを以下に示します： ZCatalystFolder folder = ZCatalystApp.getInstance() .getFileStoreInstance() .getFolderInstance(2823000000006561); //フォルダーインスタンスを定義する try{ var (response, files) = await folder.getFiles(); for (var file in files) { print(file.name); //成功時に実行するアクション } } on ZCatalystException catch (ex) { print(ex.toString()); } -------------------------------------------------------------------------------- title: "ファイルのアップロード" description: "File Store内の既存のフォルダにファイルをアップロードできます。" last_updated: "2026-06-10T06:04:54.123Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/file-store/upload-file/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Upload File - API (/ja/api/code-reference/cloud-scale/file-store/upload-file-in-folder/#UploadFileInaFolder) -------------------------------------------------------------------------------- # ファイルのアップロード 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 **uploadFile()**メソッドを呼び出すことで、File Store内の既存のフォルダにファイルをアップロードできます。ファイルがフォルダにアップロードされると、一意のファイルIDが生成されます。画像、テキストドキュメント、CSV、またはその他の必要な種類のファイルをアップロードできます。 以下のすべてのメソッドのコードセクションで使用される&lt;FOLDER_INSTANCE&gt;は、フォルダインスタンスページで定義されたインスタンスです。これは、ファイルをアップロードするフォルダを参照します。 Future<(APIResponse, ZCatalystFile)> &lt;FOLDER_INSTANCE&gt;.uploadFile(String filePath, String fileName) **パラメータ**: * **filepath**: アップロードするファイルのファイルパス * **fileName**: アップロードするファイルの名前 フォルダインスタンスを含むサンプルコードスニペットを以下に示します： ZCatalystFolder folder = ZCatalystApp.getInstance() .getFileStoreInstance() .getFolderInstance(2823000000006561); //フォルダーインスタンスを定義する and specify the ID of the folder to upload the file in try{ var (response, file) = await folder.uploadFile( 'assets/images/product_image.webp', 'sample_product'); print('File Upload Success: ${file.name}'); } on ZCatalystException catch (ex) { print(ex.toString()); } -------------------------------------------------------------------------------- title: "ファイルのダウンロード" description: "File Store内の既存のフォルダからファイルをダウンロードできます。" last_updated: "2026-06-10T06:04:54.123Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/file-store/download-file/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Download File - API (/ja/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder) -------------------------------------------------------------------------------- # ファイルのダウンロード 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 **download()**メソッドを呼び出すことで、File Store内の既存のフォルダからファイルをダウンロードできます。ファイルは設定したファイルパスに自動的にダウンロードされ、設定したファイル名が割り当てられます。以下の例に示すように、これらの値をdownload()メソッドの引数として渡すことができます。 以下のコードで使用される&lt;FILE_INSTANCE&gt;は、サンプルコードスニペットに示すように、特定のファイルに対して作成されたインスタンスです。これは、一意のファイルIDによって特定のフォルダからダウンロードするファイルを参照します。 Future<(APIResponse, String)> &lt;FILE_INSTANCE&gt;.download( void Function(int, int, double) inProgress) ファイルインスタンスを含むサンプルコードスニペットを以下に示します： ZCatalystFolder folder = ZCatalystApp.getInstance() .getFileStoreInstance() .getFolderInstance(2823000000006561); try{ var (_, file) = folder.getFile(2823000000006561); var (_, downloadedFilePath) = await file.download( filePath: '/desktop/files/', fileName: 'red.webp', onProgress: (bytesWritten, contentLength, percentage) { print('${percentage}%'); }); print(downloadedFilePath); } on ZCatalystException catch (ex) { print(ex.toString()); } -------------------------------------------------------------------------------- title: "ファイルの削除" description: "File Store内のフォルダから既存のファイルを削除できます。" last_updated: "2026-06-10T06:04:54.123Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/file-store/delete-file/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Delete File - API (/ja/api/code-reference/cloud-scale/file-store/delete-file/#DeleteFile) -------------------------------------------------------------------------------- # ファイルの削除 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 **delete()**メソッドを呼び出し、ファイルインスタンスでファイルを参照することで、File Store内のフォルダから既存のファイルを削除できます。これにより、ファイルは完全に削除されます。 以下のコードで使用される&lt;FILE_INSTANCE&gt;は、サンプルコードスニペットに示すように、特定のファイルに対して作成されたインスタンスです。これは、一意のファイルIDによって削除するファイルを参照します。 Future&lt;APIResponse&gt; &lt;FILE_INSTANCE&gt;.delete() サンプルコードスニペットを以下に示します： ZCatalystFolder folder = ZCatalystApp.getInstance() .getFileStoreInstance() .getFolderInstance(2823000000006561); try{ var (_ file) = await folder.getFile(2823000000006561); await file.delete(); print('File deleted successfully.'); } on ZCatalystException catch (ex) { print(ex.toString()); } ##### Stratus -------------------------------------------------------------------------------- title: "概要" description: "このページでは、Stratus操作を実行するために必要なモバイルSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.124Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/stratus/overview/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/overview/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/overview/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/overview/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # 概要 Cloud Scale Stratusは、Catalystの堅牢で強力なストレージソリューションです。バケットと呼ばれるコンテナ内に、オブジェクトの形式であらゆるフォーマットのデータを保存できます。各バケットおよびバケット内の各オブジェクトには、安全なオブジェクトURLとバケットURLがあります。オブジェクトに対してアップロードおよびダウンロード操作を実行でき、各オブジェクトにカスタム権限を設定することもできます。 以下の表は、コードを通じてStratus操作を実行するために使用できるすべてのCatalyst SDKのリストです。 <table class="content-table"> <thead> <tr> <th class="w30p">カテゴリ</th> <th class="w70p">SDKメソッド</th> </tr> </thead> <tbody> <tr> <td>一般的なStratus操作</td> <td> <ul> <li>Stratusの初期化 <ul> <li>バケットインスタンスの初期化</li> </ul> </li> </ul> </td> </tr> <tr> <td>バケット操作</td> <td> <ul> <li>オブジェクトの取得 <ul> <li>すべてのオブジェクトの取得</li> </ul> </li> <li>オブジェクトのダウンロード</li> <li>オブジェクトのアップロード</li> <li>オブジェクトの削除</li> <li>パスの削除</li> </ul> </td> </tr> </tbody> </table> 注意: このセクションのすべてのSDKメソッドは、Dartの新機能であるRecordsを使用して複数のデータを返します。この機能を使用するには、Dart v3.0以上が必要です。 -------------------------------------------------------------------------------- title: "Stratusの初期化" description: "このページでは、バケットインスタンスを作成するためのFlutter SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.124Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/stratus/initialize-stratus/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/create-stratus-instance/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/create-stratus-instance/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/create-stratus-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/initialize-stratus-instance/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/create-bucket-instance/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Stratusの初期化 以下に示すように、stratusコンポーネントの参照を取得できます。これはサーバーサイドのコールを発生させません。このコンポーネントインスタンスは、Stratusを操作するさまざまなコードスニペットで参照します。 ZCatalystStratus stratus = ZCatalystApp.getInstance().stratus ### バケットインスタンスの初期化 バケットレベルの操作を実行するには、バケットインスタンスを初期化する必要があります。このコンポーネントインスタンスは、Stratusのバケットを操作するさまざまなコードスニペットで参照します。 ZCatalystBucket bucket = stratus.bucket("{bucket_name}") -------------------------------------------------------------------------------- title: "オブジェクトの取得" description: "このページでは、バケットからオブジェクトを取得するためのFlutter SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.124Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/stratus/get-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/get-objects/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/get-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/get-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/get-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/create-bucket-instance/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/get-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-objects/#GetAllObjects) -------------------------------------------------------------------------------- # オブジェクトの取得 このSDKメソッドは、バケットからオブジェクトを取得するために使用できます。レスポンスは**blob**形式で返されます。 バケットでバージョニングが有効になっている場合： * versionIdを渡さない場合、**最新のオブジェクト**のみが返されます。 * 特定のバージョンを取得するには、有効なバージョンを値としてversionIdクエリパラメータを使用します。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>String</td> <td>必須パラメータ。オブジェクトの名前を保持します。</td> </tr> <tr> <td>versionId</td> <td>String</td> <td>任意パラメータ。必要なオブジェクトのバージョンの一意のバージョンIDを保持します。</td> </tr> </tbody> </table> try { ZCatalystBucket bucket = stratus.bucket("testing"); var (response, object) = await bucket.getObject("SunSet.jpeg", "01hter85pvexb8s2s2842rpswh"); print('Object Name : ${object.name}'); } on ZCatalystException catch (ex) { print(ex.toString()); } ### すべてのオブジェクトの取得 このSDKメソッドは、ページネーション技術を使用してバケット内のすべてのオブジェクトを取得するために使用できます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>prefix</td> <td>String</td> <td>任意パラメータ。プレフィックス値に一致するオブジェクトを取得します。</td> </tr> <tr> <td>maxKeys</td> <td>Number</td> <td>任意パラメータ。ページネーションで一覧表示できるオブジェクトの最大数を含みます。</td> </tr> <tr> <td>continuationToken</td> <td>String</td> <td>任意パラメータ。レスポンスが切り詰められた場合、次のオブジェクトセットを取得するために、このキーの値を同じメソッドにcontinuationTokenとして渡す必要があります。</td> </tr> </tbody> </table> try { ZCatalystBucket bucket = app.stratus.bucket("testing"); var (response, objects, resInfo) = await bucket.getObjects(maxKeys: 5); for (var object in objects) { print('Object Name : ${object.name}'); } print('Res Info MaxKeys:${resInfo.maxKeys}'); print('\n\n'); } on ZCatalystException catch (ex) { print(ex.toString()); } -------------------------------------------------------------------------------- title: "オブジェクトのダウンロード" description: "このページでは、バケットにオブジェクトをダウンロードするためのFlutter SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.124Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/stratus/download-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Download an Object (/ja/cloud-scale/help/stratus/objects/manage-object/download-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/range-download/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/range-download/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/range-download/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/range-download/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/download-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/download-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/upload-object/#DownloadObject) -------------------------------------------------------------------------------- # オブジェクトのダウンロード このSDKメソッドを使用すると、オブジェクトをダウンロードできます。操作は入力ストリームを返します。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>pathToDownload</td> <td>String</td> <td>必須パラメータ。オブジェクトをダウンロードする必要があるパスを保持します。</td> </tr> <tr> <td>newObjectName</td> <td>String</td> <td>任意パラメータ。ダウンロード時に指定するオブジェクトの名前を保持します。この値を指定しない場合、オブジェクトは元の名前でダウンロードされます。</td> </tr> <tr> <td>versionId</td> <td>String</td> <td>任意パラメータ。バケットでバージョニングが有効になっている場合、必要なオブジェクトのバージョンの一意のバージョンIDを保持します。</td> </tr> <tr> <td>fromCache</td> <td>Boolean</td> <td> <ul> <li>任意パラメータ。このファイルをキャッシュから取得するかどうかを指定するために使用します。</li> <li>デフォルト値: false。</li> </ul> </td> </tr> <tr> <td>progress</td> <td>Function(int, int, Double)?</td> <td>オブジェクトのダウンロードの進捗情報を提供するコールバック関数</td> </tr> </tbody> </table> try { ZCatalystBucket bucket = stratus.bucket("testing"); var (response, object) = await bucket.getObject("SunSet.jpeg"); final downloadsDir = await getExternalStorageDirectory(); final filePath = downloadsDir!.absolute.path; var fileResponse = await object.download( pathToDownload: filePath, onProgress: (bytesWritten, contentLength, percentage) { print("Downloaded Percentage: $percentage"); }, ); print("Download Status: ${fileResponse.statusCode}"); OpenFile.open(filePath + '/SunSet.jpeg'); } on ZCatalystException catch (ex) { print(ex.toString()); } -------------------------------------------------------------------------------- title: "オブジェクトのアップロード" description: "このページでは、バケットにオブジェクトをアップロードするためのFlutter SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.124Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/stratus/upload-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Upload Object Help Documentation (/ja/cloud-scale/help/stratus/objects/upload-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/upload-object/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/upload-object/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/upload-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/upload-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/upload-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/upload-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/upload-object/#UploadObject) -------------------------------------------------------------------------------- # オブジェクトのアップロード このセクションに記載されているSDKメソッドを使用すると、バケットにオブジェクトをアップロードできます。 オブジェクトでバージョニングが有効になっていない場合、Stratusが同じオブジェクトに対して複数の書き込みリクエストを受信すると、オブジェクトは継続的に上書きされます。オブジェクトの最新のアップロードのみが保存されます。 ただし、バージョニングが有効になっている場合、各アップロードはオブジェクトのバージョンとして扱われ、それぞれ一意のversionIdを持ってバケットに保存されます。 注意: パスまたはオブジェクトの作成時に、スペースを含む以下の文字はサポートされていません：ダブルクォート、両方の山括弧、ハッシュタグ、バックスラッシュ、パイプ記号。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>filePath</td> <td>String</td> <td>必須パラメータ。ファイルのアップロード元の場所の完全なパスを含みます。</td> </tr> <tr> <td>shouldCompress</td> <td>Boolean</td> <td> <ul> <li>任意パラメータ。オブジェクトを圧縮するかどうかを選択できます。</li> <li>デフォルト値: false。</li> </ul> </td> </tr> </tbody> </table> try { XFile ? imageFile = await pickImage(ImageSource.gallery); var bucket = stratus.bucket("testing"); var response = await bucket.uploadObject(imageFile!.path); print("Upload Status: ${response.statusCode}"); } on ZCatalystException catch (ex) { print(ex.toString()); } -------------------------------------------------------------------------------- title: "オブジェクトの削除" description: "このページでは、バケットからオブジェクトを削除するためのFlutter SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.124Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/stratus/delete-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Delete an Object Help Documentation (/ja/cloud-scale/help/stratus/objects/manage-object/delete-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/delete-objects/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/delete-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/delete-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/delete-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/delete-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/delete-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/delete-objects/#DeleteObject) -------------------------------------------------------------------------------- # オブジェクトの削除 以下のSDKメソッドを使用して、バケットから複数のオブジェクトを削除できます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w30p">データ型</th> <th class="w50p">定義</th> </tr> </thead> <tbody> <tr> <td>objects</td> <td>ArrayList&lt;ZCatalystObject&gt;</td> <td>削除する必要があるオブジェクト（およびバケットでバージョニングが有効な場合はバージョンID）のリストを含む配列。</td> </tr> </tbody> </table> 注意: objectsパラメータなしでSDKメソッドを使用すると、バケット内のすべてのオブジェクトが削除されます。 try { ZCatalystBucket bucket = stratus.bucket("testing"); var (response, objects, _) = await bucket.getObjects(maxKeys: 5, prefix: 'trip'); var response = await bucket.deleteObjects(objects); print("Delete Objects: ${response.statusCode}"); } on ZCatalystException catch (ex) { print(ex.toString()); } -------------------------------------------------------------------------------- title: "パスの削除" description: "このページでは、バケットからパス全体とそのオブジェクトを削除するためのFlutter SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.124Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/stratus/delete-path/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Delete an Object Help Documentation (/ja/cloud-scale/help/stratus/objects/manage-object/delete-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/delete-objects/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/delete-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/delete-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/delete-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/delete-path/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/delete-path/) - REST API (/ja/api/code-reference/cloud-scale/stratus/delete-path/#DeletePath) -------------------------------------------------------------------------------- # パスの削除 以下のSDKメソッドを使用して、指定されたパス内のすべてのオブジェクトを削除できます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>path</td> <td>String</td> <td>必須パラメータ。ファイルをアップロードするパスの完全なパスを含みます。</td> </tr> </tbody> </table> try { ZCatalystBucket bucket = stratus.bucket("testing"); var response = await bucket.deletePath("photos"); print("Delete Objects: ${response.statusCode}"); } on ZCatalystException catch (ex) { print(ex.toString()); } ##### ZCQL -------------------------------------------------------------------------------- title: "ZCQLクエリの実行" description: "ZCQLは、Data Storeでデータの作成、取得、および変更操作を実行できるCatalyst独自のクエリ言語です。" last_updated: "2026-06-10T06:04:54.125Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/zcql/execute-zcql-query/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - ZCQL (/ja/cloud-scale/help/zcql/introduction/) - Execute ZCQL - API (/ja/api/code-reference/cloud-scale/zcql/execute-zcql-query/#ExecuteZCQLQuery) -------------------------------------------------------------------------------- # ZCQL ZCQLは、Data Storeでデータの作成、取得、および変更操作を実行できるCatalyst独自のクエリ言語です。組み込み関数、SQL Join句、その他のステートメントおよび条件を含むクエリをサポートしています。 ### ZCQLクエリの実行 Flutterでは、ZCQLを使用してデータ取得操作を実行できます。必要なデータセットを取得するためにZCQLクエリを実行する前に、**getData()**メソッドに渡すクエリを構築する必要があります。ZCQL構文については、ZCQLヘルプページで確認できます。 以下のZCQLクエリ実行のコード構文に示すように、**ZCatalystSelectQuery**のインスタンスをgetData()メソッドに渡す必要があります。 ここで使用される&lt;DATA_STORE_INSTANCE&gt;は、Data Storeインスタンスページで定義されたインスタンスです。 Future<(APIResponse, List&lt;dynamic&gt;?)> ZCatalystApp.getInstance().getDataStoreInstance().getData( ZCatalystSelectQuery selectQuery) **パラメータ**: * **selectQuery**: 渡すZCatalystSelectQuery型のインスタンス ZCQLでサポートされるステートメント用のZCatalystSelectQueryのselectQueryインスタンスは、以下の方法で作成できます： ZCatalystSelectQuery.Builder() .select(columns: Set&lt;Column&gt;): ZCatalystSelectQuery.Builder .selectAll(): ZCatalystSelectQuery.Builder .where(column: String, comparator: ZCatalystUtil.Comparator, value: String): ZCatalystSelectQuery.Builder .from(tableName: String): ZCatalystSelectQuery.Builder .and(column: String, comparator: ZCatalystUtil.Comparator, value: String): ZCatalystSelectQuery.Builder .groupBy(columns: Set&lt;Column&gt;): ZCatalystSelectQuery.Builder .orderBy(columns: Set&lt;Column&gt;, sortOrder: ZCatalystUtil.SortOrder): ZCatalystSelectQuery.Builder .innerJoin(tableName: String): ZCatalystSelectQuery.Builder .leftJoin(tableName: String): ZCatalystSelectQuery.Builder .on(joinColumn1: String, comparator: ZCatalystUtil.Comparator, joinColumn2: String): ZCatalystSelectQuery.Builder .or(column: String, comparator: ZCatalystUtil.Comparator, value:String): ZCatalystSelectQuery.Builder .limit(offset: Int, value: Int?): ZCatalystSelectQuery.Builder .build(): ZCatalystSelectQuery ZCQLクエリ実行のサンプルコードスニペットを以下に示します： try { ZCQLColumn column1 = ZCQLColumn('Title'); ZCQLColumn column2 = ZCQLColumn('Category'); Set&lt;ZCQLColumn&gt; columns = Set(); columns.add(column1); columns.add(column2); ZCatalystSelectQuery query = ZCatalystQueryBuilder() .select(columns) .from('Projects') .where('Category', Comparator.EQUAL_TO, 'Official') .build(); var (_, result) = await app.getDataStoreInstance().getData(query); print("Query Result: $result"); } on ZCatalystException catch (ex) { print(ex.toString()); } ##### プッシュ通知 -------------------------------------------------------------------------------- title: "プッシュ通知用デバイスの登録" description: "このページでは、Flutterアプリの登録とエンロール後に、iOSまたはAndroidデバイスをリモートプッシュ通知に登録するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.125Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/push-notifications/register-device/" service: "Cloud Scale" related: - Push Notifications (/ja/cloud-scale/help/push-notifications/introduction) - Push Notifications API (/ja/api/code-reference/cloud-scale/push-notifications/ios/send-ios-push-notifications/#SendiOSPushNotifications) - Push Notifications Android SDK (/ja/sdk/android/v2/cloud-scale/push-notifications/register-device/) - Push Notifications iOS SDK (/ja/sdk/ios/v2/cloud-scale/push-notifications/register-device/) -------------------------------------------------------------------------------- # プッシュ通知 ### はじめに Catalystプッシュ通知を使用すると、アプリがユーザーデバイスでアクティブに実行されていない場合でも、アプリケーションのユーザーにリモート通知を送信できます。Catalystは、Catalystウェブ、iOS、およびAndroidアプリケーションにプッシュ通知を簡単に統合する方法を提供します。 Flutter SDKを通じてプッシュ通知を実装する場合、アプリを構築するプラットフォームに応じて、iOSまたはAndroidの前提条件を満たす必要があります。これらの前提条件を以下に説明します。 ### iOSアプリの前提条件 iOSアプリでプッシュ通知を送信する前に、アプリを登録してCatalystプッシュ通知にエンロールするための一連の手順に従う必要があります。以下に手順を順に示します： 1. AppleにiOSアプリを登録する 2. Keychain Accessから証明書を生成する 3. Appleが提供するAPNs証明書を生成してダウンロードする 4. ダウンロードしたAPNs証明書を.p12形式に変換する 5. CatalystでiOSプッシュ通知サービスにエンロールする 6. プッシュ通知用にモバイルデバイスを登録する 注意: 最初の5つの手順は、プッシュ通知 - iOSヘルプセクションで詳しく説明されています。このSDKヘルプドキュメントでは、プッシュ通知を送信するためのデバイスの登録に関する6番目の手順、およびデバイスの登録解除についてのみ説明します。このセクションのコードを使用する前に、プッシュ通知ヘルプドキュメントを参照して手順1～5を実装できます。 <br> ### Androidアプリの前提条件 プッシュ通知を送信する前に、アプリを登録してCatalystプッシュ通知にエンロールするための一連の手順に従う必要があります。以下に手順を順に示します： 1. FirebaseのAndroid設定ファイルを生成する 2. Firebaseアクセス用の秘密鍵を生成する 3. CatalystでAndroidプッシュ通知サービスを設定する 4. プッシュ通知用にモバイルデバイスを登録する 注意: 最初の3つの手順は、プッシュ通知 - Androidヘルプセクションで詳しく説明されています。このSDKヘルプドキュメントでは、プッシュ通知を送信するためのデバイスの登録に関する4番目の手順、およびデバイスの登録解除についてのみ説明します。このセクションのコードを使用する前に、プッシュ通知ヘルプドキュメントを参照して手順1～3を実装できます。 ### プッシュ通知用モバイルデバイスの登録 作業しているプラットフォームの上記の前提条件を完了した後、デバイスをCatalystプッシュ通知に登録する以下のコードをアプリのコードベースに実装できます。 Flutterモバイルデバイスをテストデバイスとして登録するには、以下のコードスニペットに示すように、必要なパラメータを指定してregisterNotification()メソッドを呼び出す必要があります： try { var response = await ZCatalystApp.getInstance().registerNotification(deviceToken: deviceToken, notificationAppId: '1624000000074620',isTestDevice: false); print(response?.responseJson); } on ZCatalystException catch (ex) { log("Register Failed: $ex"); } **パラメータ:** * deviceToken: AndroidアプリのFCMから取得したデバイストークン、またはiOSアプリのAPNSにリモートプッシュ通知用にデバイスを登録した後に取得したデバイストークン。 * notificationAppID: Androidの場合、これはCatalystがプッシュ通知でAndroidアプリ用に生成したアプリIDです。Catalystコンソールのプッシュ通知のAndroidセクションで確認できます。iOSの場合、これはCatalystにiOSアプリを登録した際にCatalystがアプリ用に生成したAppConfigurationDevelopment.plist/ AppConfigurationProduction.plistファイルから取得されます。 * testDevice: テストデバイスの場合は値をtrueに設定し、本番デバイスの場合はfalseに設定します。 <br> 注意: Androidプッシュ通知をテストするために、最大10台のAndroidまたはiOSデバイスをテストデバイスとして登録できます。 デバイスが登録されると、アプリユーザーにプッシュ通知を送信できるようになります。ユーザーは、デバイスの許可プロンプトから**許可**をクリックして、アプリがプッシュ通知を送信する許可を提供する必要があります。 登録済みデバイスへのテストプッシュ通知の送信については、CatalystコンソールからiOSアプリおよびAndroidアプリのそれぞれのヘルプドキュメントで確認できます。また、APIからテスト通知を送信することもできます。 コードベースを通じたプッシュ通知の送信については、Java、Node.js、およびPython SDKドキュメントを参照してください。 -------------------------------------------------------------------------------- title: "プッシュ通知用デバイスの登録解除" description: "このページでは、登録済みのiOSまたはAndroidデバイスのリモートプッシュ通知の登録を解除するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.125Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/push-notifications/deregister-device/" service: "Cloud Scale" related: - Push Notifications (/ja/cloud-scale/help/push-notifications/introduction) - Push Notifications API (/ja/api/code-reference/cloud-scale/push-notifications/ios/send-ios-push-notifications/#SendiOSPushNotifications) - Push Notifications Android SDK (/ja/sdk/android/v2/cloud-scale/push-notifications/register-device/) - Push Notifications iOS SDK (/ja/sdk/ios/v2/cloud-scale/push-notifications/register-device/) -------------------------------------------------------------------------------- # プッシュ通知用モバイルデバイスの登録解除 以下に示すように、必要なパラメータをderegisterNotification()メソッドに渡すことで、Catalyst iOSプッシュ通知に登録されていたデバイスの登録を解除できます。 try{ var response = await ZCatalystApp.getInstance() .deregisterNotification( deviceToken: deviceToken, notificationAppId: "1624000000074620", isTestDevice: false); print(response?.responseJson); } on ZCatalystException catch(ex) { print("Failed to deregister device: $ex"); } **パラメータ:** * deviceToken: AndroidアプリのFCMから取得したデバイストークン、またはiOSアプリのAPNSにリモートプッシュ通知用にデバイスを登録した後に取得したデバイストークン。 * notificationAppID: Androidの場合、これはCatalystがプッシュ通知でAndroidアプリ用に生成したアプリIDです。Catalystコンソールのプッシュ通知のAndroidセクションで確認できます。iOSの場合、これはCatalystにiOSアプリを登録した際にCatalystがアプリ用に生成したAppConfigurationDevelopment.plist/ AppConfigurationProduction.plistファイルから取得されます。 * testDevice: テストデバイスの場合は値をtrueに設定し、本番デバイスの場合はfalseに設定します。 ##### 検索 -------------------------------------------------------------------------------- title: "テーブル内のデータ検索" description: "Catalyst Searchは、Data Store内のテーブルのインデックス付きカラムでデータ検索を可能にします。単一の検索クエリで大量のデータを強力に検索できます。" last_updated: "2026-06-10T06:04:54.125Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/search/search-data-in-tables/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Search (/ja/cloud-scale/help/search-integration/introduction) - Search - API (/ja/api/code-reference/cloud-scale/zcql/execute-zcql-query/#ExecuteZCQLQuery) -------------------------------------------------------------------------------- # Search Catalyst Searchは、Data Store内のテーブルのインデックス付きカラムでデータ検索を可能にします。単一の検索クエリで大量のデータを強力に検索できます。 注意: 検索するカラムにはインデックスが設定されている必要があります。カラムの作成時または後から編集して検索インデックスを有効にできます。 ### テーブル内のデータ検索 特定のパターンでテーブル内のデータを検索するには、テーブル名を識別子として指定し、検索するカラムを追加する必要があります。カラムを配列に追加し、クラスZCatalystSearchOptionsのインスタンスを通じて検索キーワードと共に**search()**メソッドに配列を渡す必要があります。 以下のコード構文に示すように、検索操作を実行する前にsearch()メソッドに渡す検索パターンを構築する必要があります。 Future<(APIResponse, Map&lt;String, dynamic&gt;?)> search(ZCatalystSearchOptions searchOptions) **パラメータ**: * **searchOptions**: search()メソッドに渡す**ZCatalystSearchOptions**クラスのインスタンス searchOptionsのインスタンスは以下の方法で作成できます： ZCatalystSearchOptions(searchText: String, List&lt;ZCatalystSearchOptions.TableColumns&gt;) .addSortColumn(tableName: String,columnName: String) .setDisplayColumns(displayTableColumns: List&lt;ZCatalystSearchOptions.TableColumns&gt;) .setSearchColumns(searchTableColumns: List&lt;ZCatalystSearchOptions.TableColumns&gt;) .setSearchPattern(pattern: ZCatalystSearchOptions.SearchPattern) 検索実行のサンプルコードスニペットを以下に示します： List&lt;TableColumn&gt; searchTableColumns = []; //配列を作成する TableColumn tableColumn = TableColumn('Products'); //テーブルを指定する //検索する列を指定する tableColumn.addColumn('Title'); tableColumn.addColumn('Category'); searchTableColumns.add(tableColumn); //配列にカラムを追加する ZCatalystSearchOptions searchOptions = ZCatalystSearchOptions('Official', searchTableColumns); //キーワードと検索する配列を渡す try{ var (_, searchResult) = await ZCatalystApp.getInstance().search(searchOptions); print(searchResult); } on ZCatalystException catch (ex) { print('Search Query Result :'); } ##### 認証 -------------------------------------------------------------------------------- title: "ユーザーインスタンスの作成" description: "Flutterアプリでユーザー操作を行うための新しいユーザーインスタンスを作成できます。" last_updated: "2026-06-10T06:04:54.125Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/authentication/create-user-instance/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Add New User - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # Authentication Catalyst Authenticationの機能を使用すると、Catalystアプリのユーザー認証を管理し、ユーザーを追加し、ユーザーアカウントを設定できます。 ## 新しいユーザーインスタンスの作成 新しいユーザーインスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。これにより、不要なサーバー呼び出しを防ぐことができます。 以下のコード構文に示すように、ユーザーの詳細を**newUser()**メソッドに渡す必要があります。インスタンスを正常に作成するには、ユーザーのメールアドレスと名前を必須で渡す必要があります。 ZCatalystUserDelegate newUser({ required String firstName, required String emailId, String? lastName, ZCatalystRole? role, }) **パラメーター**: * **lastName**（必須）: 新しいユーザーの姓です。 * **email**（必須）: 招待メールが送信されるユーザーのメールアドレスです。 * **lastName**: 新しいユーザーの姓です。 * **role**: ユーザーに割り当てるロールです。 サンプルコードスニペットを以下に示します： ZCatalystUserDelegate newUser = ZCatalystApp.getInstance().newUser( firstName: 'Patricia', emailId: 'p.boyle@zylker.com', lastname: 'Boyle', role: Admin, ); -------------------------------------------------------------------------------- title: "ユーザーサインアップ" description: "サインアップを通じてFlutterアプリケーションに新しいユーザーを追加できます。" last_updated: "2026-06-10T06:04:54.125Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/authentication/user-signup/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Authentication - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # ユーザーサインアップ **signUp()**メソッドを呼び出すことで、Catalystアプリに新しいユーザーを追加できます。こちらで定義したユーザーインスタンスを引数としてsignup()メソッドに渡す必要があります。 ユーザーサインアップのコード構文を以下に示します： Future<(APIResponse, ZCatalystUser)> signUp(ZCatalystUserDelegate newUser) **パラメーター**: * **newUser**: この操作の前に作成されたユーザーインスタンスです サンプルコードスニペットを以下に示します： ZCatalystApp.getInstance().newUser( firstName: 'Patricia', emailId: 'p.boyle@zylker.com', ); try { var (response, user) = await ZCatalystApp.getInstance().signUp(newUser); print('User ID: ${user.id}') } on ZCatalystException catch (ex) { print(ex.toString()); } -------------------------------------------------------------------------------- title: "ユーザーログイン" description: "Catalyst Flutterアプリのエンドユーザーにログインページを表示できます。" last_updated: "2026-06-10T06:04:54.125Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/authentication/user-login/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Authentication - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # ユーザーログイン **login()**メソッドを使用して、Catalyst Flutterアプリのエンドユーザーにログインページを表示できます。これは、ユーザーがアプリからログアウトしている場合に表示されます。ログインが成功すると、ユーザーはアプリにアクセスできるようになります。 サンプルコードスニペットを以下に示します： await ZCatalystApp.getInstance().login() -------------------------------------------------------------------------------- title: "ユーザーログアウト" description: "Catalyst Flutterアプリからアプリユーザーをログアウトできます。" last_updated: "2026-06-10T06:04:54.125Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/authentication/user-logout/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Logout User - API (/ja/api/code-reference/cloud-scale/authentication/sign-out-user/#SignOutUser) -------------------------------------------------------------------------------- # ユーザーログアウト logout()メソッドは、Catalyst Flutterアプリからアプリユーザーをログアウトできます。 サンプルコードスニペットを以下に示します： await ZCatalystApp.getInstance().logout() -------------------------------------------------------------------------------- title: "ユーザー認証ステータス" description: "Flutterアプリユーザーの認証ステータスを簡単に確認できます。" last_updated: "2026-06-10T06:04:54.125Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/authentication/user-authentication-status/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Authentication - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # ユーザー認証ステータス isUserLoggedIn()メソッドを使用して、アプリユーザーの認証ステータスを確認できます。これは、ユーザーのログインステータスに関するブーリアンレスポンスを返します。 ユーザーログアウトのコード構文を以下に示します： bool isUserLoggedIn = await ZCatalystApp.getInstance().isUserLoggedIn(); //ステータスの取得に成功した際に実行するアクション サンプルコードスニペットを以下に示します： bool isUserLoggedIn = await ZCatalystApp.getInstance().isUserLoggedIn(); print(isUserLoggedIn); //"true"または"false"を出力します -------------------------------------------------------------------------------- title: "現在のユーザーの取得" description: "Flutterアプリケーションの現在のエンドユーザーの詳細を取得できます。" last_updated: "2026-06-10T06:04:54.125Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/authentication/get-current-user/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Add New User - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # 現在のユーザーの取得 getCurrentUser()メソッドを呼び出すことで、アプリケーションの現在のエンドユーザーの詳細を取得できます。正常に実行されると、このメソッドは現在のユーザーオブジェクトを返します。これを使用して、名前、姓、メールアドレスなど、Catalystに登録されているユーザーの詳細を取得できます。 現在のユーザーを取得するためのコード構文を以下に示します： ZCatalystApp.getInstance().getCurrentUser( void Function() onSuccess, void Function(ZCatalystException) onFailed ) サンプルコードスニペットを以下に示します： try { var (response, user) = await app.getCurrentUser(); print('User ID: ${user.id}') } on ZCatalystException catch (ex) { print(ex.toString()); } -------------------------------------------------------------------------------- title: "サードパーティ認証" description: "Flutterアプリに任意のサードパーティ認証サービスを実装できます。" last_updated: "2026-06-10T06:04:54.125Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/cloud-scale/authentication/third-party-authentication/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Third-Party Authentication (/ja/cloud-scale/help/authentication/third-party-authentication/introduction/) - Generate Custom Server Token- Java SDK (/ja/sdk/java/v1/cloud-scale/authentication/third-party-server-token/) - Generate Custom Server Token- Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/authentication/third-party-server-token/) - Generate Custom Server Token- Python SDK (/ja/sdk/python/v1/cloud-scale/authentication/third-party-server-token/) - Authentication - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # サードパーティ認証 Cloud ScaleのAuthenticationでは、Catalystアプリケーションに任意のサードパーティ認証サービスを実装できます。エンドユーザーの認可と検証はサードパーティサービスによって処理され、データはCatalystに渡されます。 Note: サードパーティ認証サービスを実装しているため、アプリケーションのセキュリティインフラストラクチャは、選択したサードパーティサービスの効率性に依存することをご了承ください。 モバイルアプリにサードパーティ認証を実装するには、以下に説明する手順を実行する必要があります。 ### 1. サードパーティ認証サービスの設定 サードパーティ認証をCatalystアプリケーションに関連付ける前に、外部サービスでのサードパーティロジックの処理を完了していることを確認してください。任意のサードパーティで認証を設定できます。 <br> ### 2. Catalystでのサードパーティ認証タイプのセットアップ CatalystコンソールのCloud ScaleのAuthenticationコンポーネントに移動して、設定したサードパーティ認証をCatalystでセットアップする必要があります。手順はCatalystでのサードパーティ認証のセットアップのヘルプページで説明されています。 このプロセスには、以下の手順が含まれます： **i. カスタムサーバートークンの生成：** ユーザーが認証後にサードパーティサービスからリダイレクトされると、そのクレデンシャルをJava、Node.js、またはPythonでコーディングする必要がある認証関数に渡す必要があります。この関数はCatalystサーバーサイドトークン**jwtToken**または**customToken**を生成し、クライアント側（Flutterアプリ）に渡されます。CatalystコンソールはcustomTokenを生成するためのすぐに使えるスクリプトを提供しています。このスクリプトを、customTokenを返すサーバーサイド関数に組み込むことができます。 Note: Catalystアプリケーションでサードパーティ認証を有効にするには、コンソールでPublic Signupを有効にしていることを確認してください。 **ii. クライアント側の設定をスキップする：** コンソールでのクライアント側の設定は今はスキップできます。ログインプロセスを完了するために、最後にクライアントロジックにカスタムサーバートークンを組み込みます。 **iii. 追加設定の構成とセットアップの完了：** ホワイトリストの一部としてCustomer User ValidationまたはAuthorized Domainsを設定し、セットアップを完了します。 Catalystは、サードパーティ認証サービスが有効になり、アプリケーションの認証がそのサービスによって処理されていることを確認表示します。 <br> ### 3. FlutterプロジェクトにConfiguration Fileを再インポートする Catalystコンソールからアプリのサードパーティ認証を有効にした後、アプリを開発しているプラットフォームとアプリの環境に基づいて、Flutterプロジェクトにプロパティファイルを再度ダウンロードしてインポートする必要があります。つまり、Androidアプリを開発している場合はapp_configuration_developmentまたはapp_configuration_productionファイルをダウンロードし、iOSアプリを開発している場合はAppConfigurationDevelopment.plistまたはAppConfigurationProduction.plistファイルをダウンロードしてください。 このファイルには、JWTClientIDとJWTClientSecretの2つの追加プロパティが含まれるためです。これらのプロパティは、SDKを再初期化した後の次のステップで渡す必要があります。 設定ファイルを再ダウンロードするには： 1. プロジェクトのCatalystコンソールで**Settings**に移動し、次に**Developer Tools**に移動します。Mobile SDKセクションに既存のAndroidまたはiOSパッケージがあります。必要なパッケージを開きます。 <br> 2. ポップアップで必要な環境タブをクリックし、**Download**をクリックして設定ファイルをダウンロードします。 <br> ダウンロードした設定ファイルを、Android向けはこちら、iOS向けはこちらに記載された手順に従って再インポートできます。 Note: Android SDKセットアップのステップ3〜5、またはiOS SDKセットアップのステップ3、4、6は再度実行する必要はありません。 <br> ### 4. Flutter SDKの再初期化 新しくダウンロードしたプロパティをコードに含めるために、SDKを再初期化する必要があります。SDKの再初期化も、最初のSDK初期化と同様に、Catalyst設定ファイルを使用する方法とカスタムSDK Configurationオブジェクトを渡す方法の2つの方法で行えます。ただし、サードパーティ認証を確認するための追加のSDKメソッドが含まれます。 #### 1. Catalyst Configuration Fileを使用する方法 プロジェクトの環境を指定するか、Production環境がデフォルトとみなされる環境を指定せずに行うことができます。 **環境を指定する場合：** 以下に示すようにSDKを再初期化できます。Environmentの値は、アプリが動作している環境に基づいてDEVELOPMENTまたはPRODUCTIONのいずれかを渡すことができます。isCustomLoginは、サードパーティ認証の存在を示すブーリアン値です。 これらは、以下に示すようにZCatalystAppクラスのinit()メソッドに渡されます： ZCatalystApp.init({ ZCatalystEnvironment? environment, bool isCustomLogin = false }); この操作のサンプルコードスニペットを以下に示します： void main() async { try { await ZCatalystApp.init( environment: ZCatalystEnvironment.DEVELOPMENT, isCustomLogin: true ); } on ZCatalystException catch (ex) { print('Initialized Failed: ${ex.toString()}'); } } <br> **環境を指定しない場合：** SDKの初期化時にEnvironmentが指定されない場合、デフォルトでPRODUCTIONとみなされます。そのため、アプリがProduction環境で動作している場合は、以下の方法で直接SDKを初期化できます： ZCatalystApp.init({ bool isCustomLogin = false }); この操作のサンプルコードスニペットを以下に示します： void main() async { try { await ZCatalystApp.init( isCustomLogin: true ); } on ZCatalystException catch (ex) { print('Initialized Failed: ${ex.toString()}'); } } <br> #### 2. カスタムSDK Configurationオブジェクトを渡す方法： 別の方法として、ZCatalystSDKConfigsBuilderクラスを使用して渡せるカスタムZCatalystSDKConfigsオブジェクトを構築して、Flutter SDKを再初期化できます。このオブジェクトに含まれるプロパティについてはこちらを参照してください。 この方法では、新しくダウンロードした設定ファイルから取得したJWTClientIDとJWTClientSecretのプロパティをZCatalystSDKConfigsBuilderを通じて指定してSDKを再初期化することもできます。 以下の方法で行うことができます： ZCatalystApp.init({ ZCatalystSDKConfigs? sdkConfigs, ZCatalystEnvironment? environment, bool isCustomLogin = true }); サンプルコードスニペットを以下に示します： ZCatalystSDKConfigs configs = ZCatalystSDKConfigsBuilder.customLogin( accountsPortalBaseURL: "https://accounts.zohoportal.com/", apiBaseURL: "https://api.catalyst.zoho.com/", environment: ZCatalystEnvironment.DEVELOPMENT, jwtClientID: "100****************************FX", jwtClientSecret: "19ed***************************2s", oauthScopes: "ZOHOCATALYST.tables.rows.ALL, ZOHOCATALYST.tables.columns.ALL", portalID: "10******79", projectID:28*****90 , redirectURL: "*****" ); <br> ### 5. サードパーティ認証のユーザーログインロジックのコーディング ここで、モバイルアプリでサードパーティ認証のログインロジックを処理してセットアップを完了できます。[ステップ2](/ja/sdk/flutter/v2/cloud-scale/authentication/third-party-authentication/#2-set-up-the-third-party-authentication-type-in-catalyst)で生成したcustomTokenまたはjwtTokenを、以下に示すようにhandleCustomLogin()メソッドに渡す必要があります： Future&lt;void&gt; handleCustomLogin(String jwtToken) サンプルコードスニペットを以下に示します： await ZCatalystApp.getInstance().handleCustomLogin("123xxxxxxxx"); Note: カスタムサーバートークンは、ユーザーがサードパーティ認証サービスを使用してアプリケーションにログインするたびに生成する必要があります。 #### General -------------------------------------------------------------------------------- title: "現在のタイムゾーンの取得" description: "プロジェクトで現在アクティブなタイムゾーンを取得できます。" last_updated: "2026-06-10T06:04:54.127Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/general/get-current-time-zone/" service: "All Services" related: - Time Zone Settings (/ja/getting-started/set-up-a-catalyst-project/general-settings/#change-the-time-zone-of-the-project) -------------------------------------------------------------------------------- # 現在のタイムゾーンの取得 コンソールの一般設定から、プロジェクトのタイムゾーンを定義して保存できます。これにより、アクセスするデータセンターに基づいて設定されたデフォルトのタイムゾーンが上書きされます。設定したタイムゾーンは、プロジェクトのすべてのサービス、コンポーネント、および機能に適用されます。ただし、特定のコンポーネントに対して個別のタイムゾーンを定義することも可能です。 Catalystでは、プロジェクトで現在アクティブなタイムゾーンを取得できます。以下の構文に示すように、ZCatalystUtilクラスのgetCurrentTimeZone()メソッドを使用して、コンソールでプロジェクトに定義された現在のタイムゾーンを取得できます。 Future<String> ZCatalystUtil.getCurrentTimezone() サンプルコードスニペットを以下に示します： String currTimezone = await ZCatalystUtil.getCurrentTimeZone(); #### Serverless ##### ファンクション -------------------------------------------------------------------------------- title: "ファンクションインスタンスの作成" description: "Catalystファンクションを使用すると、アプリケーションにカスタム機能を構築したり、タスクを自動化したり、サードパーティサービスと統合したりできます。" last_updated: "2026-06-10T06:04:54.128Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/serverless/functions/create-function-instance/" service: "Serverless" related: - Functions (/ja/serverless/help/functions/introduction) - Function - API (/ja/api/code-reference/serverless/functions/execute-function/#ExecuteFunction) -------------------------------------------------------------------------------- # Functions Catalyst Serverless Functionsを使用すると、アプリケーションにカスタム機能を構築したり、タスクを自動化したり、サードパーティサービスと統合したりできます。Catalystコンソールまたはcliからモバイルアプリ用のファンクションを開発できます。 注意: Catalystでは6種類のファンクションを作成できます：Basic I/O、Advanced I/O、Cron、Event、Integration、およびBrowser Logicファンクションです。ただし、Catalyst Flutter SDKではBasic I/Oファンクションのみ実行できます。 ### ファンクションインスタンスの作成 **getFunctionInstance()**メソッドを使用してCatalystファンクションのインスタンスを作成し、このクラスで定義されたメソッドがインスタンスオブジェクトにアクセスできるようにすることができます。これにより、不要なサーバーコールを防止できます。 ファンクションインスタンスは2つの異なる方法で取得できます。 ### ファンクションIDを渡す方法 以下の構文に示すように、ファンクションのIDをString形式でgetFunctionInstance()メソッドの引数として渡すことで、ファンクションインスタンスを作成できます： ZCatalystApp.getInstance().getFunctionInstance( String identifier ) **パラメータ**: * **functionID**: Catalystで設定されたファンクションの一意のID サンプルコードスニペットを以下に示します： ZCatalystFunction function = ZCatalystApp.getInstance().getFunctionInstance(identifier: "158798998356682"); <br> ### ファンクションのAPI名を渡す方法 以下の構文に示すように、ファンクションのAPI名をString形式でgetFunctionInstance()メソッドの引数として渡すことで、ファンクションインスタンスを作成できます： ZCatalystApp.getInstance().getFunctionInstance( String identifier ) **パラメータ**: * **identifier**: Catalystで設定されたファンクションの名前 サンプルコードスニペットを以下に示します： ZCatalystFunction function = ZCatalystApp.getInstance().getFunctionInstance(identifier: "LocalBackUp"); -------------------------------------------------------------------------------- title: "ファンクションの実行" description: "ファンクションに渡すHTTPリクエストに基づいて、複数の方法でCatalystファンクションを実行できます。" last_updated: "2026-06-10T06:04:54.128Z" source: "https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/serverless/functions/execute-function/" service: "Serverless" related: - Functions (/ja/serverless/help/functions/introduction) - Implementing Functions (/ja/serverless/help/functions/implementation) - Execute Function - API (/ja/api/code-reference/serverless/functions/execute-function/#ExecuteFunction) -------------------------------------------------------------------------------- # ファンクションの実行 ファンクションに渡すHTTPリクエストに基づいて、以下のいずれかの方法でCatalyst Basic I/Oファンクションを実行できます。実行するファンクションにパラメータをファンクション実行メソッドの引数として渡すことができます。このメソッドはHTTPリクエストタイプごとに異なります。 以下のすべてのコードセクションで使用される&lt;FUNCTION_INSTANCE&gt;は、ファンクションインスタンスページで定義されたインスタンスです。 ### GETファンクションの実行 パラメータをHash mapとして**executeGET()**メソッドに渡すことで、HTTP GETタイプのファンクションを実行できます： Future&lt;String?&gt; &lt;FUNCTION_INSTANCE&gt;.executeGET( Map&lt;String, Dynamic&gt; params) **パラメータ**: * **params**: Hash mapとしてファンクションに渡すパラメータ サンプルコードスニペットを以下に示します： ZCatalystFunction function = ZCatalystApp.getInstance().getFunctionInstance(identifier: "LocalBackUp"); try{ var output = function.executeGET( params: { 'id': 2345642, //パラメーターを関数に渡す }); print('Function output: $output'); } on ZCatalystException catch (ex) { print(ex.toString()); } <br> ### PUTファンクションの実行 パラメータをHash mapとして**executePUT()**メソッドに渡すことで、HTTP PUTタイプのファンクションを実行できます。PUTリクエストのペイロードもHash map引数としてこのメソッドに渡すことができます： Future&lt;String?&gt; &lt;FUNCTION_INSTANCE&gt;.executePUT(Map&lt;String, Dynamic&gt; body, [Map&lt;String, Dynamic&gt;? params]) **パラメータ**: * **params**: Hash mapとしてファンクションに渡すパラメータ * **body**: Hash mapとして渡すデータペイロード サンプルコードスニペットを以下に示します： ZCatalystFunction function = ZCatalystApp.getInstance().getFunctionInstance(identifier: 'LocalBackUp'); var body = &lt;String, Dynamic&gt;{ "ROWID": "2823000000098012", "Category": "Important" }; //関数インスタンスを定義してペイロードをマップに渡す try{ var output = await function.executePUT( body: body, params: { 'id': 2345642, //パラメーターを関数に渡す }); print('Function output: $output'); } on ZCatalystException catch (ex) { print(ex.toString()); } <br> ### POSTファンクションの実行 パラメータをHash mapとして**executePOST()**メソッドに渡すことで、HTTP POSTタイプのファンクションを実行できます。POSTリクエストのペイロードもHash map引数としてこのメソッドに渡すことができます： Future&lt;String?&gt; executePOST(Map&lt;String, dynamic&gt; body) **パラメータ**: * **params**: Hash mapとしてファンクションに渡すパラメータ * **body**: Hash mapとして渡すデータペイロード サンプルコードスニペットを以下に示します： ZCatalystFunction function = ZCatalystApp.getInstance().getFunctionInstance(identifier: 'LocalBackUp'); var body = &lt;String, Dynamic&gt;{ "ROWID": "2823000000098012", "Category": "Important" //関数インスタンスを定義してペイロードをハッシュマップに渡す }; try{ var output = await function.executePOST(body: body); print('Function output: $output'); } on ZCatalystException catch (ex) { print(ex.toString()); } ### DELETEファンクションの実行 パラメータをHash mapとして**executeDELETE()**メソッドに渡すことで、HTTP DELETEタイプのファンクションを実行できます。DELETEリクエストのペイロードもHash map引数としてこのメソッドに渡すことができます： Future&lt;APIResponse&gt; &lt;FUNCTION_INSTANCE&gt;.executeDELETE(Map&lt;String, Dynamic&gt; body, [Map&lt;String, Dynamic&gt;? params]) **パラメータ**: * **params**: Hash mapとしてファンクションに渡すパラメータ * **body**: Hash mapとして渡すデータペイロード サンプルコードスニペットを以下に示します： try { ZCatalystFunction function = app.getFunctionInstance(identifier: 'DeleteData'); var response = await function.executeDELETE({"id": 298922}); } on ZCatalystException catch (ex) { print(ex.toString()); } ## iOS ### v2 -------------------------------------------------------------------------------- title: "概要" description: "Catalyst iOS SDKは、Catalystプロジェクト用のiOSアプリを構築するためのライブラリです。" last_updated: "2026-06-10T06:04:54.138Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/overview/" service: "All Services" related: - Mobile Device Management (/ja/cloud-scale/help/mobile-device-management/introduction) - Android SDK (/ja/sdk/android/v2/overview/) - Flutter SDK (/ja/sdk/flutter/v2/overview/) - Web SDK (/ja/sdk/web/v4/overview/) -------------------------------------------------------------------------------- # iOS SDK ## 概要 Catalyst iOS SDKは、iOSプラットフォームでCatalystプロジェクト用のモバイルアプリを構築するためのライブラリです。Catalyst iOS SDKパッケージには、強力なバックエンドを備えたダイナミックで堅牢なiOSアプリの開発を支援する多くのツールと機能が含まれています。 iOS SDKパッケージは、さまざまなCatalystサービスやコンポーネントの複数のバックエンドジョブを処理できます。主に、iOS SDKにはCatalyst Cloud ScaleおよびCatalyst Serverlessの機能（ユーザー認証とリダイレクト、Data StoreおよびFile Storeの機能、関数の実行など）のためのツールが含まれています。 iOS SDKは、これらのコンポーネントへのAPIリクエストをメソッド呼び出しとしてラップしており、利用することができます。SDKパッケージが提供するすぐに使える機能を実装することで、これらのCatalystコンポーネントをiOSアプリにシームレスに統合し、簡単に構築することができます。これにより、バックエンドをゼロからコーディングする時間と労力を節約し、アプリのユーザーエクスペリエンスの設計により集中できます。 iOS SDKドキュメントでは、Catalyst iOS SDKを使用してiOSアプリをセットアップおよび構築するプロセス全体について説明しています。このドキュメントでは、SDKパッケージのアーキテクチャ、コンポーネント、構成について学び、さまざまな操作のサンプルコードスニペットにアクセスできます。 Note: iOSアプリの開発とテストが完了したら、Mobile Device Managementを使用してアプリをホストおよび配布できます。また、Catalystコンソールからアプリのバージョニングとエンドユーザーを簡単に管理することもできます。さらに、CatalystでPush NotificationsをiOSアプリ用に設定し、アプリ内でプッシュ通知の送信を有効にすることもできます。ただし、Push NotificationsおよびMobile Device Managementは、EU、AU、IN、またはCAデータセンターからアクセスしているCatalystユーザーには現在利用できません。 -------------------------------------------------------------------------------- title: "クラス階層" description: "クラス階層は、Catalyst iOS SDKにおけるSwiftクラスの階層構造を示します。" last_updated: "2026-06-10T06:04:54.138Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/class-heirarchy/" service: "All Services" related: - Authentication (/ja/cloud-scale/help/mobile-device-management/introduction) - Data Store (/ja/cloud-scale/help/data-store/introduction) - File Store (/ja/cloud-scale/help/file-store/introduction) - Search (/ja/cloud-scale/help/search-integration/introduction/) - Functions (/ja/serverless/help/functions/introduction) - ZCQL (/ja/cloud-scale/help/zcql/introduction) -------------------------------------------------------------------------------- # クラス階層 ### はじめに すべてのCatalystコンポーネントは、iOS SDKにおいてSwiftクラスとしてモデル化されています。これらのコンポーネントクラスのメンバーとメソッドはコンポーネントの動作を定義し、コンポーネント内でさまざまな操作を実行できるようにします。 Catalyst iOS SDKパッケージには、さまざまなCatalystサービスの以下のCatalystコンポーネントおよび機能を操作するためのツールが含まれています。 * **General:** Timezone * **Serverless:** Functions * **Cloud Scale:** Authentication, Data Store, File Store, Search, ZCQL Catalyst iOS SDKコンポーネントクラスの階層構造は、以下のアーキテクチャ図に示されています。 **ZCatalystApp**は、Catalyst iOS SDKの基底クラスです。SDKを初期化し、Catalystプロジェクトのさまざまなコンポーネントにアクセスするためのメソッドが複数含まれています。他のクラスは、それぞれのコンポーネントおよびSDKがサポートする固有の機能に対応しています。 <br> ### インスタンスオブジェクト ZCatalystAppの下にある各クラスには、API呼び出しを実行して直下の子エンティティのプロパティとデータを取得する関数が含まれています。 しかし、下位レベルのコンポーネントのデータを取得するために、常にクラス階層の最上位までたどることは効率的ではありません。これは、各レベルでAPI呼び出しが発生し、アプリケーションの使用効率が低下するためです。この状況を回避し、アプリをよりコスト効率の良いものにするために、Catalystはすべてのクラスにインスタンスオブジェクトを提供しています。 **インスタンスオブジェクト**は各コンポーネントクラスに存在し、**getInstance()**メソッドを通じてアクセスできます。このメソッドはコンポーネントのダミーオブジェクトを取得し、そのオブジェクトを使用してすべての子エンティティのメソッドを取得できます。 したがって、Catalystコンポーネントのプロパティを取得するには、コンポーネントのオブジェクトをgetInstance()メソッドで呼び出す必要があります。その後、同じオブジェクトを使用して、コンポーネントが定義する他のメソッドを呼び出します。これにより、不要で過剰なAPI呼び出しを防ぐことができます。 -------------------------------------------------------------------------------- title: "エラー" description: "このヘルプページでは、Catalyst iOSアプリの実行中に発生する可能性のある一般的なエラーを一覧で示します。" last_updated: "2026-06-10T06:04:54.139Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/errors/" service: "All Services" related: - Developer Tools (/ja/getting-started/set-up-a-catalyst-project/developer-tools) -------------------------------------------------------------------------------- # エラー エラーとは、アプリの実行中に発生する予期しない不具合です。Catalyst iOSアプリのすべてのエラーと例外は、iOS SDKパッケージで定義されている**ZCatalystError**という列挙型によって処理されます。 アプリでエラーが発生した場合、以下のエラープロパティが返されます。 * **code**: エラーの一意の識別子 * **message**: エラーに関する一般的な説明 * **details**: エラーに関する追加情報 Catalyst iOS SDKがスローする一般的なエラーコードとその説明を以下に示します。 <table class="content-table"> <thead> <tr> <th class="w30p">エラーコード</th> <th class="w70p">説明</th> </tr> </thead> <tbody> <tr> <td><strong>INVALID_DATA</strong></td> <td>データの形式が無効です</td> </tr> <tr> <td><strong>INTERNAL_ERROR</strong></td> <td>内部的な問題、サーバー、またはその他の原因でエラーが発生しました</td> </tr> <tr> <td><strong>RESPONSE_NIL</strong></td> <td>サーバーからレスポンスが返されませんでした</td> </tr> <tr> <td><strong>TOKEN_FETCH_ERROR</strong></td> <td>アクセストークンの取得に失敗しました</td> </tr> <tr> <td><strong>OAUTH_FETCH_ERROR</strong></td> <td>OAUTHトークンの取得中にエラーが発生しました</td> </tr> <tr> <td><strong>UNABLE_TO_CONSTRUCT_URL</strong></td> <td>URLの構築中にエラーが発生しました</td> </tr> <tr> <td><strong>PROCESSING_ERROR</strong></td> <td>データの処理中にエラーが発生しました</td> </tr> <tr> <td><strong>TYPECAST_ERROR</strong></td> <td>データの型変換中にエラーが発生しました</td> </tr> <tr> <td><strong>NO_INTERNET_CONNECTION</strong></td> <td>デバイスがインターネットに接続されていません</td> </tr> <tr> <td><strong>REQUEST_TIMEOUT</strong></td> <td>サーバーからのレスポンスが時間内に届きませんでした</td> </tr> <tr> <td><strong>NETWORK_CONNECTION_LOST</strong></td> <td>デバイスのインターネット接続が失われました</td> </tr> <tr> <td><strong>INITIALIZATION_ERROR</strong></td> <td>SDKの初期化中にエラーが発生しました</td> </tr> <tr> <td><strong>FUNCTION_EXECUTION_ERROR</strong></td> <td>関数の実行中にエラーが発生しました</td> </tr> <tr> <td><strong>JSON_EXCEPTION</strong></td> <td>JSONの解析中にエラーが発生しました</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "前提条件" description: "Catalyst iOS SDKを使用した開発を開始する前に実行する必要がある手順" last_updated: "2026-06-10T06:04:54.139Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/prerequisites/" service: "All Services" related: - Android (/ja/sdk/android/v2/overview) - Catalyst Project (/ja/getting-started/catalyst-projects/) -------------------------------------------------------------------------------- # 前提条件 Catalyst iOS SDKの使用を開始する前に、以下のすべての前提条件を満たしていることを確認してください。 * モバイルアプリをホストするために、CatalystコンソールでCatalystプロジェクトを作成します Note: 各プロジェクトでは、Androidアプリ1つとiOSアプリ1つをホストできます。 * XCodeでiOSプロジェクトを作成またはインポートします Note: 各プロジェクトでは、Androidアプリ1つとiOSアプリ1つをホストできます。AndroidまたはiOSは、Catalyst AndroidまたはiOS SDKを使用してネイティブに構築するか、Catalyst Flutter SDKを使用して構築できます。 * iOSプロジェクトと開発環境が以下の**最小サポート環境**を満たしていることを確認してください。 * XCode- 10.2以降 * CocoaPods * iOS- 9以降 * Swift- 4以降 前提条件の環境を設定した後、アプリをCatalystに登録し、アプリに合わせてカスタマイズされた設定ファイルをダウンロードできます。この設定ファイルには、アプリが正しく機能するために必要な特定のプロパティの定義が含まれているため、iOSアプリの構造に含める必要があります。 これらの手順については、次のセクションで詳しく説明します。 -------------------------------------------------------------------------------- title: "セットアップ" description: "CatalystプロジェクトとiOSプロジェクトをセットアップするための手順。" last_updated: "2026-06-10T06:04:54.139Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/setup/" service: "All Services" related: - Developer Tools (/ja/getting-started/set-up-a-catalyst-project/developer-tools) -------------------------------------------------------------------------------- # セットアップ CatalystプロジェクトとiOSプロジェクトを作成した後、以下の手順に従ってiOS SDKパッケージをアプリにセットアップおよび統合する必要があります。 ### Step 1: iOSアプリをCatalystに登録する まず、CatalystでiOSアプリのパッケージを作成して登録し、固有の設定ファイルをダウンロードします。 1. プロジェクトのCatalystコンソールから**設定アイコン**をクリックします。 2. 設定メニューのProject Settingsの下にある**Developer Tools**に移動し、**iOS**タイルをクリックします。 または、下の**Add Package**ボタンをクリックすることもできます。 3. 一意に識別できるパッケージ名を入力します。エンドユーザーがアプリにログインした後にリダイレクトするURLを、Redirect URLとして指定します。 ここで入力した値は、設定ファイルに自動的に入力されます。 Note: パッケージ名はそのOSに一意に関連付けられます。そのため、AndroidとiOSの両方のアプリに同じ名前のパッケージを作成することはできません。一意の値を指定する必要があります。 OSタイプとしてiOSが選択されていることを確認してください。 4. **Create**をクリックして、モバイルSDKパッケージを作成します。 5. コンソールに設定ファイルをダウンロードできるウィンドウが表示されます。**Download**をクリックしてファイルをダウンロードします。 必要なすべての設定が含まれたファイルがダウンロードされます。このファイルのプロパティについては、次のステップで説明します。 ### Step 2: iOSプロジェクトに設定ファイルをインポートする Catalystは、アプリケーションを開発・構築するために、**Development**サンドボックスとライブの**Production**環境の2つの作業環境を提供しています。詳細については、環境のヘルプページをご覧ください。 コンソールでパッケージを作成すると、現在作業している環境に関係なく、最初はDevelopment環境の設定ファイルのみがダウンロード可能です。パッケージが作成された後は、いつでもコンソールから任意の環境の設定ファイルをダウンロードできます。 各環境の設定ファイルの名前は以下の通りです。 * Development: **AppConfigurationDevelopment.plist** * Production: **AppConfigurationProduction.plist** 作業している環境に基づいて、適切なファイルをダウンロードし、iOSプロジェクトの**Targets** -> **Runner**に追加する必要があります。Production環境の設定ファイルを取得するには、まずプロジェクトをProductionにデプロイしてから、Developer Tools設定セクションからファイルをダウンロードする必要があります。 設定ファイルは、iOSプロジェクトの**Targets** -> **Runner**に追加する必要があります。 iOSプロジェクト構造の詳細については、公式iOSドキュメントを参照してください。 #### AppConfigurationDevelopment.plist/ AppConfigurationProduction.plistファイルのプロパティ アプリ設定ファイルは、以下の表に記載されたプロパティを定義します。リクエストヘッダーを除くすべての値は、プロジェクトの詳細またはデフォルトの標準に基づいて自動的に入力されます。 Note: これらの値の取得元については、表に記載されたリンクを参照してください。 <table class="content-table"> <thead> <tr> <th class="w20p">プロパティ</th> <th class="w20p">データ型</th> <th class="w20p">説明</th> </tr> </thead> <tbody> <tr> <td>**ClientID**</td> <td>String</td> <td>Catalystに登録されたアプリクライアントの一意の識別子です。設定ファイルで提供されます。</td> </tr> <tr> <td>**ClientSecretID**</td> <td>String</td> <td>特定のclientIDに対して生成されるシークレット値で、APIリクエストとともに渡されます。設定ファイルで提供されます。</td> </tr> <tr> <td>**PortalID**</td> <td>String</td> <td>設定ファイルで提供される一意の識別子です</td> </tr> <tr> <td>**RedirectURLScheme**</td> <td>String</td> <td>前のステップでコンソールでパッケージを作成する際に指定した、アプリのコールバックURLです</td> </tr> <tr> <td>**ProjectID**</td> <td>Long</td> <td>Catalystプロジェクトの一意のIDです</td> </tr> <tr> <td>**APIBaseURL**</td> <td>String</td> <td>内部APIが呼び出されるCatalystサーバーのURLです。作業している環境に基づいて、適切なURL（Development URLまたはProduction URL）を使用する必要があります。</td> </tr> <tr> <td>**APIVersion**</td> <td>String</td> <td>APIのバージョンです</td> </tr> <tr> <td>**OauthScopes**</td> <td>String</td> <td>プロジェクトからCatalyst APIにアクセスするためにアプリが使用するスコープです。利用可能なOAuthスコープはこちらで確認できます。</td> </tr> <tr> <td>**RequestHeaders**</td> <td>String</td> <td>HTTPリクエストでクライアントが送信するヘッダーです<br /> リクエストヘッダーの値は、次のようにカンマで区切られた個別のキーと値のペアである必要があります: requestHeaders=key1:value1, key2:value2</td> </tr> <tr> <td>**ServerTLD**</td> <td>String</td> <td>データサーバーのトップレベルドメインです<br /> 使用可能な値: **AU**, **CN**, **COM**, **EU**, **IN**</td> </tr> <tr> <td>**MinLogLevel**</td> <td>String</td> <td>アプリのログ設定を行うことができます<br /> 使用可能な値: **warnings**, **errors**, **information**, **debug**, **ALL**</td> </tr> <tr> <td>**TurnLoggerOn**</td> <td>Boolean</td> <td>値に基づいてロガーをオンにします<br /> 使用可能な値: **true**, **false**</td> </tr> <tr> <td>**RequestTimeOut**</td> <td>Double</td> <td>追加データの到着を待機してからタイムアウトするまでの時間（秒単位）です</td> </tr> <tr> <td>**X-Catalyst-Environment**</td> <td>String</td> <td>設定ファイルがダウンロードされた環境（DevelopmentまたはProduction）です</td> </tr> <tr> <td>**X-CATALYST-USER**</td> <td>String</td> <td>アプリユーザーのユーザーロールです</td> </tr> <tr> <td>**AccountsPortalDomain**</td> <td>String</td> <td>Zohoアカウントのポータルドメインです</td> </tr> <tr> <td>**notificationAppID**</td> <td>String</td> <td>iOSアプリのPush Notificationsに登録した後にCatalystによって生成されるIDです</td> </tr> <tr> <td>**JWTClientID**</td> <td>String</td> <td>クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントIDプロパティです</td> </tr> <tr> <td>**JWTClientSecret**</td> <td>String</td> <td>クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントシークレットプロパティです</td> </tr> </tbody> </table> Note:<br /> * **clientID**、**clientSecretID**、**projectID**、または**portalID**の値を設定ファイルで変更すると、SDKおよびiOSアプリの機能に影響します。これらの設定を変更する場合は、Developer Toolsセクションから必要なプロジェクトの新しいパッケージを作成し、適切な環境の新しい設定ファイルをダウンロードして、iOSプロジェクトに追加してください。 * ダウンロードした設定ファイルに入力されたプロパティの値は、**ZCatalystApp.configs**オブジェクトを使用して動的にアクセスできます。 ### Step 3: アプリにCatalyst iOS SDKを追加する 次のステップは、SDKパッケージをアプリに含めることです。CocoaPodsを使用してCatalyst SDKライブラリをインストールできます。 新規または既存のプロジェクトにCatalyst iOS SDKを依存関係として追加するには: 1. プロジェクトの**Podfile**のアプリのターゲットの下に、以下のコードスニペットを挿入します: pod 'ZCatalyst', :git =>'https://github.com/zoho/Catalyst-iOS-SDK.git', :tag => '2.2.2' 2. システムのターミナルから**pod install**コマンドを実行します。 これによりPodがインストールされ、Catalyst iOS SDKがiOSアプリに追加されます。 ### Step 4: アプリのログインリダイレクトを設定する ユーザーがアプリに正常にログインすると、アプリのホーム画面にリダイレクトされます。このユーザーログインとリダイレクトはCatalyst SDKによって処理されます。 このリダイレクトが正しく処理されるようにするには、iOSプロジェクトの**info.plist**ファイルに、以下のキーを同じ設定で含めてください: Key - **URL Types** -----> **URL Schemes**<br /> Type - String<br /> Value - Catalystでアプリのパッケージを作成する際に設定したRedirect URL ### Step 5: SDKを初期化する SDKパッケージで定義されたメソッドと機能を有効にするために、Catalyst SDKを初期化する必要があります。 したがって、SDKメソッドを使用するようにアプリを設定する前に、以下の方法でSDKを初期化する必要があります: public func initSDK( window : UIWindow, environment : ZCatalystEnvironment, appConfiguration : ZCatalystAppConfiguration ) throws **パラメータ:** * **window**: ビューにイベントをディスパッチするウィンドウオブジェクト * **environment**: アプリの環境。**.development**または**.production**のいずれかです。 * **appConfiguration**: SDKの機能に必要なすべての設定詳細を含むオブジェクト ここでのenvironmentは、アプリがDevelopmentまたはProduction環境で動作しているかを示します。環境に基づいて適切なplist設定ファイルをアプリのプロジェクトに含めるのと同様に、適切な環境でSDKを初期化する必要があります。 Note: * AppConfigurationDevelopment.plistまたはAppConfigurationProduction.plistファイルに変更を加えた場合、SDKを再初期化する必要があります。 * iOSアプリにサードパーティ認証を設定した場合、この設定ファイルに新しいプロパティが追加されるため、SDKの再初期化も必要です。詳細については、こちらのヘルプページをご覧ください。 SDKが正常に初期化されると、アプリはコンポーネントメソッドを呼び出し、意図した通りに機能します。 ### Step 6: アプリケーション画面へのリダイレクトを設定する iOSアプリに設定したログインページが別のドメインからのものである場合、アプリケーション画面へのリダイレクトを設定できます。ログインに成功すると、アプリケーションレイヤーにリダイレクトされます。 UIApplicationインスタンスのコードは以下の通りです: ZCatalystApp.shared.handleLoginRedirection( _ url : URL, sourceApplication : String?, annotation : Any ) AppDelegate.swift **パラメータ:** * **url**: ログイン成功後に開くURLリソース * **sourceApplication**: URLを開くことを要求しているアプリのバンドルID * **annotation**: アプリがURLとともに送信する追加データ UISceneインスタンスのコードは以下の通りです: func scene(_ scene: UIScene, openURLContexts URLContexts: Set&lt;UIOpenURLContext&gt;) { if let context = URLContexts.first { ZCatalystApp.shared.handleLoginRedirection(context.url, sourceApplication: context.options.sourceApplication, annotation: context.options.annotation as Any) } } セットアップは完了です。Catalyst iOS SDKを使用してiOSアプリを構築できます。 #### Cloud Scale ##### Data Store -------------------------------------------------------------------------------- title: "新しいData Storeインスタンスの作成" description: "アプリケーションの現在のエンドユーザーの詳細を取得できます。" last_updated: "2026-06-10T06:04:54.140Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/data-store/create-data-store-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Data Store - API (/ja/api/code-reference/cloud-scale/data-store/insert-new-row/#InsertNewRow) -------------------------------------------------------------------------------- # Data Store Catalyst Data Storeは、アプリケーションの永続データをテーブル形式で保存するクラウドベースのリレーショナルデータベース管理システムです。 ### 新しいData Storeインスタンスの作成 CatalystプロジェクトのData Storeにアクセスするために、Data Storeのインスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。これにより、不要なサーバー呼び出しを防ぐことができます。 Data Storeインスタンスを正常に取得するには、以下のコード構文に示すように**getDataStoreInstance()**メソッドを呼び出す必要があります: ZCatalystApp.shared.getDataStoreInstance(tableIdentifier : String) -> ZCatalystDataStore -------------------------------------------------------------------------------- title: "カラムメタデータの取得" description: "指定されたインスタンスのData Storeテーブルのすべてのカラムまたは特定のカラムのメタデータを、IDまたは名前で取得できます。" last_updated: "2026-06-10T06:04:54.140Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/data-store/get-column-metadata/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Columns (/ja/cloud-scale/help/data-store/columns) - Get Metadata of Coulumns - API (/ja/api/code-reference/cloud-scale/data-store/get-all-columns-metadata/#GetAllColumnsMetadata) -------------------------------------------------------------------------------- # カラムメタデータの取得 ### 特定のカラムのメタデータを取得する **getColumn()**メソッドを呼び出すことで、指定されたインスタンスのData Storeテーブルの特定のカラムのメタデータを取得できます。操作が成功すると、このメソッドはカラムのデータ型、デフォルト値、最大長、読み取り専用・一意・必須かどうかなどのメタデータを返すことができます。 以下のコード構文に示すように、カラムIDをgetColumn()メソッドの引数として渡すことで、特定のカラムのメタデータを取得できます。ここで使用されている&lt;DATA_STORE_INSTANCE&gt;は、テーブルインスタンスページで定義されたインスタンスです。 &lt;DATA_STORE_INSTANCE&gt;.getColumn( id : Int64, completion : @escaping ( Result&lt; ZCatalystColumn, ZCatalystError &gt; ) -> Void ) **パラメータ**: * **id**: 取得する特定のカラムの一意のカラムID * **completion**: 操作が成功した場合、completionブロックはカラムの詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットは以下の通りです: ZCatalystApp.shared.getDataStoreInstance(tableIdentifier : String).getColumn(id :1096000000002459 ) { ( result ) in //ここにカラムIDを入力してください switch result{ case .success ( let column) : print(column.name) case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } ### すべてのカラムのメタデータを取得する 以下のコード構文に示すように、**getColumns()**メソッドを使用して、指定されたインスタンスのテーブルのすべてのカラムのメタデータを取得できます。操作が成功すると、このメソッドは特定のテーブルのすべてのカラムのメタデータを返すことができます。 以下のコードで使用されている&lt;DATA_STORE_INSTANCE&gt;は、テーブルインスタンスページで先に作成されたインスタンスです。 &lt;DATA_STORE_INSTANCE&gt;.getColumns( completion : @escaping ( Result&lt; [ ZCatalystColumn ], ZCatalystError &gt; ) -> Void ) **パラメータ**: * **completion**: 操作が成功した場合、completionブロックはテーブル内のすべてのカラムの詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットは以下の通りです: ZCatalystApp.shared.getDataStoreInstance(tableIdentifier : "EmployeeDetails").getColumns{ ( result ) in // これをあなたのテーブル名に置き換えてください switch result { case .success ( let columns) : for column in columns { print(column.name) } case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } -------------------------------------------------------------------------------- title: "行の取得" description: "指定されたインスタンスのData Storeテーブルから、特定の行またはすべての行をページネーション付きで取得できます。" last_updated: "2026-06-10T06:04:54.155Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/data-store/get-rows/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Get All Rows - API (/ja/api/code-reference/cloud-scale/data-store/get-all-rows/#GetAllRows) -------------------------------------------------------------------------------- # 行の取得 ### 特定の行を取得する **getRow()**メソッドを使用して、指定されたインスタンスのData Storeテーブルから特定の行を取得できます。以下のコード構文に示すように、行の一意のROWIDをこのメソッドの引数として渡します。 以下のコードで使用されている&lt;DATA_STORE_INSTANCE&gt;は、Data Storeインスタンスページで定義されたインスタンスです。 &lt;DATA_STORE_INSTANCE&gt;.getRow(id : Int64, completion: @escaping (Result&lt;ZCatalystRow, ZCatalystError&gt;) -> Void) **パラメータ**: * **id**: 取得する特定の行の一意のROWID * **completion**: 操作が成功した場合、completionブロックは行の詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットは以下の通りです: ZCatalystApp.shared.getDataStoreInstance(tableIdentifier : "EmployeeDetails").getRow(id: 1096000000002845){( result ) in // これをあなたのテーブル識別子とROW IDに置き換えてください switch result{ case .success ( let row) : print(row.id) case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } <br> ### ページネーションを使用して行を取得する ページネーションをコードに組み込むことで、Data Storeのテーブルからすべての行を取得できます。ページネーションを使用すると、テーブルの行をバッチまたはページとして反復的に取得できます。 たとえば、100件ずつのバッチで個別のページとして行を取得する場合、各ページで取得する最大行数を定義し、以下に示すように**maxRows**を使用してカウントを指定できます。 さらに、ループの各実行後に、後続のデータ取得を認可するトークン文字列がレスポンスで返されます。後続の反復時に、これをnextTokenの値として渡すことができます。ループの最初の実行時には、nextToken文字列は渡されません。 以下のコードスニペットで使用されている&lt;DATA_STORE_INSTANCE&gt;は、Data Storeインスタンスページで定義されたインスタンスです。 &lt;DATA_STORE_INSTANCE&gt;.getRows(nextToken : String?, maxRecord : String?, completion: @escaping (Result&lt;[ZCatalystRow], ZCatalystError&gt;) -&gt; Void) **パラメータ**: * **maxRows**: この反復で取得する最大行数 * **nextToken**: 次の行セットを取得するための認可トークン 最初の反復後にすべての残りの行を取得する場合は、maxRowsの制限を渡さないこともできます。すべての行が取得されると、ページネーションは完了します。 <br> ### すべての行を取得する 以下のコード構文に示すように、**getRows()**メソッドを使用して、指定されたインスタンスのテーブルのすべての行を取得できます。操作が成功すると、このメソッドはフィルターや条件なしでテーブルのすべての行を返します。 以下のコードで使用されている&lt;DATA_STORE_INSTANCE&gt;は、Data Storeインスタンスページで定義されたインスタンスです。 &lt;DATA_STORE_INSTANCE&gt;.getRows(completion: @escaping (Result&lt;[ZCatalystRow], ZCatalystError&gt;) -> Void) **パラメータ**: * **completion**: 操作が成功した場合、completionブロックはすべての行の詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットは以下の通りです: ZCatalystApp.shared.getDataStoreInstance(tableIdentifier : "EmployeeDetails").getRows{ ( result ) in //これをあなたのテーブル名に置き換えてください switch result{ case .success ( let rows) : for row in rows{ print(row.id) } case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } -------------------------------------------------------------------------------- title: "新しい行インスタンスの作成" description: "Data Store内の特定のテーブルに新しい行インスタンスを作成できます。" last_updated: "2026-06-10T06:04:54.156Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/data-store/create-new-row-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Insert Row - API (/ja/api/code-reference/cloud-scale/data-store/insert-new-row/#InsertNewRow) -------------------------------------------------------------------------------- # 新しい行インスタンスの作成 Data Store内の特定のテーブルに新しい行インスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。これにより、不要なサーバー呼び出しを防ぐことができます。 以下のコード構文に示すように、**newRow()**メソッドを呼び出すことで行インスタンスを作成できます。 ここで使用されている&lt;DATA_STORE_INSTANCE&gt;は、Data Storeインスタンスページで定義されたインスタンスです。 &lt;DATA_STORE_INSTANCE&gt;.newRow() -> ZCatalystRow サンプルコードスニペットは以下の通りです: let instance = ZCatalystApp.shared.getDataStoreInstance(tableIdentifier: "1096000000002071" ).newRow() //ここにテーブルIDを入力してください -------------------------------------------------------------------------------- title: "行からカラム値を取得" description: "Data Storeテーブルの行内の特定のカラム値を取得できます。" last_updated: "2026-06-10T06:04:54.156Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/data-store/column-value-from-row/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Columns (/ja/cloud-scale/help/data-store/columns) - Get Metadata of Columns - API (/ja/api/code-reference/cloud-scale/data-store/get-all-columns-metadata/#GetAllColumnsMetadata) -------------------------------------------------------------------------------- # 行からカラム値を取得 Data Storeテーブルの行内の特定のカラム値を取得できます。つまり、行内の「Employee ID」カラムの値のみが必要な場合、この操作を使用して取得できます。 この操作は、以下に示す3つの方法で実行できます。 以下のすべてのコードセクションで使用されている&lt;ROW_INSTANCE&gt;は、行インスタンスページで定義されたインスタンスです。 ### カラムのデータ型がわかっている場合: let data : &lt;T&gt; = try &lt;ROW_INSTANCE&gt;.getValue(forKey: "&lt;columnName&gt;") **パラメータ**: * **T**: 期待される値のデータ型 * **columnName**: 取得するカラムの名前 サンプルコードスニペットは以下の通りです: ZCatalystApp.shared.getDataStoreInstance().getTableInstance(id: 1096000000002071).getRow(id: 1096000000002845) {( result ) in //これをあなたのテーブルIDに置き換えてください and ROWID switch result{ case .success ( let row) : do{ let data : String = try row.getValue(forKey: "EmpID") as! String print(data) } catch{ print("Error occured") } case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } ### カラムのデータ型がわからない場合: let data : &lt;T&gt;? = &lt;ROW_INSTANCE&gt;.getValue(forKey: "&lt;columnName&gt;") **パラメータ**: * **T**: 期待される値のデータ型 * **columnName**: 取得するカラムの名前 サンプルコードスニペットは以下の通りです: ZCatalystApp.shared.getDataStoreInstance().getTableInstance(id: 1096000000002071).getRow(id: 1096000000002845) {( result ) in //これをあなたのテーブルIDに置き換えてください and Row ID switch result{ case .success ( let row) : let data :String? = row.getValue(forKey: "EmpID") print(data) case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } ### getValue()を使用しない場合: let data : &lt;T&gt;? = &lt;ROW_INSTANCE&gt;[ "&lt;columnName&gt;" ] **パラメータ**: * **T**: 期待される値のデータ型 * **columnName**: 取得するカラムの名前 ZCatalystApp.shared.getDataStoreInstance().getTableInstance(id: 1096000000002071).getRow(id: 1096000000002845) {( result ) in //これをあなたのテーブルIDに置き換えてください and Row ID switch result{ case .success ( let row) : let data :String? = row[ "EmpID" ] print(data) case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } -------------------------------------------------------------------------------- title: "行データの取得" description: "特定の行の実際のデータを取得できます。" last_updated: "2026-06-10T06:04:54.156Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/data-store/get-row-data/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Get Rows - API (/ja/api/code-reference/cloud-scale/data-store/get-all-rows/#GetAllRows) -------------------------------------------------------------------------------- # 行データの取得 以下に示すように、getData()メソッドを使用して、特定の行の実際のデータを取得できます。これにより、行がディクショナリ形式で返されます。 以下のコード構文で使用されている&lt;ROW_INSTANCE&gt;は、行インスタンスページで生成されたインスタンスです。 &lt;ROW_INSTANCE&gt;.getRow() -> [ String : Any? ] サンプルコードスニペットは以下の通りです: ZCatalystApp.shared.getDataStoreInstance(tableIdentifier: "1096000000002071").getRow(id: 1096000000002845) {( result ) in //これをあなたのテーブルIDに置き換えてください and ROW ID switch result{ case .success ( let row) : let datas = row.getData() print(datas) case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } -------------------------------------------------------------------------------- title: "行にカラム値を追加" description: "行内の特定のカラムに値を設定できます。" last_updated: "2026-06-10T06:04:54.156Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/data-store/add-column-value-to-row/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Get Metadata of Coulumns - API (/ja/api/code-reference/cloud-scale/data-store/get-all-columns-metadata/#GetAllColumnsMetadata) -------------------------------------------------------------------------------- # 行にカラム値を追加 このメソッドを使用して、行内の特定のカラムに値を設定できます。行の作成時または更新時に使用できます。 以下のコードで使用されている&lt;ROW_INSTANCE&gt;は、行インスタンスページで作成されたインスタンスです。 &lt;ROW_INSTANCE&gt;.setColumnValue( columnName : String, value : Any? ) **パラメータ**: * **columnName**: 値を設定するカラムの名前 * **value**: カラムに設定する値 サンプルコードスニペットは以下の通りです: let instance = ZCatalystApp.shared.getDataStoreInstance().getTableInstance(id: 1096000000002071).newRow() //これをあなたのテーブルIDに置き換えてください instance.setColumnValue(columnName: "Department_Name", value: "Marketing") instance.setColumnValue(columnName: "Employee_Name", value: "Robert Jones") //これをあなたの列名に置き換えてください and value -------------------------------------------------------------------------------- title: "行の作成" description: "Data Storeテーブルに単一の行または複数の行を作成できます。" last_updated: "2026-06-10T06:04:54.156Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/data-store/create-rows/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Insert Row - API (/ja/api/code-reference/cloud-scale/data-store/insert-new-row/#InsertNewRow) -------------------------------------------------------------------------------- # 行の作成 ### 単一の行を作成する 以下に示すように、**newRow()**メソッドを使用して、指定されたインスタンスのData Storeテーブルに新しい行を作成できます。テーブル内の行の値を、カラム名と対応する行の値をキーと値のペアとして指定して設定する必要があります。 以下のコード構文で使用されている&lt;ROW_INSTANCE&gt;は、行インスタンスページで定義されたインスタンスです。カラム値は、カラム値の追加ページで説明されているメソッドを使用して設定されます。 **パラメータ**: * **completion**: 操作が成功した場合、completionブロックは作成された行の詳細（一意のROWIDやその他のメタ情報など）を返します。それ以外の場合は、エラーを返します。 Note: is_uniqueまたはis_mandatoryプロパティを有効にしてカラムを作成した場合、それぞれ値が一意であること、または値が必ず渡されることを確認する必要があります。また、カラムに渡すデータがカラムの設定されたデータ型であることも確認する必要があります。 サンプルコードスニペットは以下の通りです: let instance = ZCatalystApp.shared.getDataStoreInstance(tableIdentifier: "1096000000002071").newRow() //これをあなたのテーブルIDに置き換えてください instance.setColumnValue(columnName: "Department_Name", value: "Marketing") instance.setColumnValue(columnName: "Employee_Name", value: "Linda Page") //これをあなたの列名に置き換えてください and value instance.create() {(result) in switch result{ case .success ( let row) : print("A new row is successfully created with row id /(row.id)") case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } ### 複数の行を作成する iOS SDKでは、指定されたインスタンスのテーブルに一度に複数の行を作成できます。テーブルに挿入する行を含む配列を渡すことで実行します。以下のコード構造に示すように、配列を**create()**メソッドの引数として渡します。 行インスタンスページで説明されているように各行のインスタンスを作成した後、&lt;ROW_INSTANCE&gt;の配列を渡す必要があります。カラム値は、カラム値の追加ページで説明されているように設定する必要があります。 以下のコードで使用されている&lt;DATA_STORE_INSTANCE&gt;は、Data Storeインスタンスページで先に作成されたインスタンスです。 &lt;DATA_STORE_INSTANCE&gt;.create(_ rows: [ ZCatalystRow ], completion: @escaping(Result&lt;[ZCatalystRow], ZCatalystError&gt;) -> Void) **パラメータ**: * **rows**: 作成する行の配列 * **completion**: 操作が成功した場合、completionブロックは作成された行の詳細（ROWIDやその他のメタ情報など）を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットは以下の通りです: let row_instance1 = ZCatalystApp.shared.getDataStoreInstance(tableIdentifier: "1096000000002071").newRow() //ここにテーブルIDを入力してください row_instance1.setColumnValue(columnName: "Department_Name", value: "Marketing") row_instance1.setColumnValue(columnName: "Employee_Name", value: "Robert Jones") //これをあなたの列名に置き換えてください and value let row_instance2 = ZCatalystApp.shared.getDataStoreInstance(tableIdentifier: "1096000000002071").newRow() //これをあなたのテーブルIDに置き換えてください row_instance2.setColumnValue(columnName: "Department_Name", value: "Finance") row_instance2.setColumnValue(columnName: "Employee_Name", value: "Louis Smith") //これをあなたの列名に置き換えてください and value ZCatalystApp.shared.getDataStoreInstance(tableIdentifier: "1096000000002071").create([row_instance1, row_instance2]) {(result) in switch result{ case .success ( let rows) : print("The rows ids which are successfully created are listed below") for row in rows{ print(row.id) } case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } -------------------------------------------------------------------------------- title: "行の更新" description: "Data Storeテーブルの単一の行または複数の行を更新できます。" last_updated: "2026-06-10T06:04:54.156Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/data-store/update-rows/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Rows (/ja/cloud-scale/help/data-store/records) - Update Row - API (/ja/api/code-reference/cloud-scale/data-store/update-row/#UpdateRow) -------------------------------------------------------------------------------- # 行の更新 ### 特定の行を更新する **update()**メソッドを使用して、Data Storeテーブルの特定の行を更新できます。カラムの変更された値をキーと値のペアとして渡すことで、行の1つ以上のカラムの値を更新できます。 以下のコード構文で使用されている&lt;ROW_INSTANCE&gt;は、行インスタンスページで定義されたインスタンスです。 &lt;ROW_INSTANCE&gt;.update( completion: @escaping(Result&lt;ZCatalystRow, ZCatalystError&gt;) -> Void) **パラメータ**: * **completion**: 操作が成功した場合、completionブロックは更新された行の詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットは以下の通りです: ZCatalystApp.shared.getDataStoreInstance(tableIdentifier: "1096000000002071").getRow(id: 3376000000170191){(result)in //これをあなたのテーブルIDに置き換えてください switch result{ case .success ( let row) : row.setColumnValue(columnName: "Employee_Name", value: "Morgan Jones") //列名と値をここに置き換えてください row.update {(update_result) in switch update_result{ case .success(let updated_row) : print("Name is updated") case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } ### すべての行を更新する 行の配列をupdate()メソッドの引数として渡すことで、テーブル内の複数の行を更新できます。カラムの変更された値をキーと値のペアとして渡すことで、行の1つ以上のカラムの値を更新できます。 各行のインスタンスを作成し、以下のコードに示すようにカラム値の追加メソッドを使用して各対応するカラムの更新された値を渡して、更新する行インスタンスの配列を渡す必要があります。 以下のコードで使用されている&lt;DATA_STORE_INSTANCE&gt;は、テーブルインスタンスページで定義されたインスタンスです。 &lt;DATA_STORE_INSTANCE&gt;.update(_ rows: [ ZCatalystRow ], completion: @escaping(Result&lt;[ZCatalystRow], ZCatalystError&gt;) -> Void) **パラメータ**: * **rows**: 更新する行の配列 * **completion**: 操作が成功した場合、completionブロックはすべての更新された行の詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットは以下の通りです: let data_store_instance = ZCatalystApp.shared.getDataStoreInstance(tableIdentifier: "EmployeeDetails")//ここにテーブル名を入力してください data_store_instance.getRows{(result)in switch result{ case .success ( let rows) : for row in rows{ row.setColumnValue(columnName: "Employee_Name", value: "Morgan Jones") } data_store_instance.update(rows) {(result) in switch result { case .success ( let updated_rows): print("Rows has been successfully updated"); case .error( let error ) : print( "Error occurred >>> \( error )" ) } } case .error(let error): print("Error occurred >>> \( error )") } } -------------------------------------------------------------------------------- title: "行の削除" description: "Catalyst iOS SDKでは、Row IDまたは行インスタンスを使用して、特定のData Storeテーブルから単一の行を削除できます。" last_updated: "2026-06-10T06:04:54.156Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/data-store/delete-row/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Records (/ja/cloud-scale/help/data-store/records) - Delete Row - API (/ja/api/code-reference/cloud-scale/data-store/delete-row/#DeleteRow) -------------------------------------------------------------------------------- # 行の削除 Catalyst iOS SDKでは、特定のData Storeテーブルから単一の行を削除できます。ただし、一度に複数の行を削除することはできません。 テーブルから行を削除するには、以下の2つの方法のいずれかを使用できます: ### テーブルインスタンスにRow IDを渡して行を削除する 以下のコード構文に示すように、行のROWIDを**deleteRow()**メソッドの引数として渡すことで、テーブルから行を削除できます。 以下のコード構文で使用されている&lt;DATA_STORE_INSTANCE&gt;は、Data Storeインスタンスページで定義されたインスタンスです。 &lt;DATA_STORE_INSTANCE&gt;.deleteRow( id : Int64, completion : @escaping( ZCatalystError? ) -> Void ) **パラメータ**: * **id**: 削除する行の一意のROWID * **completion**: 操作が成功した場合、completionブロックは削除された行の詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットは以下の通りです: ZCatalystApp.shared.getDataStoreInstance(tableIdentifier: "1096000000002071").deleteRow(id: 3376000000171021){( error ) in //これをあなたのROWIDに置き換えてください if let error = error{ print( "Error occurred &gt;&gt;&gt; \( error )" ) } else { print("Row is successfully deleted.") } } ### 行インスタンスを渡して行を削除する 行インスタンスの**delete()**メソッドを呼び出すだけで、テーブルから行を削除できます。 以下のコード構文で使用されている&lt;ROW_INSTANCE&gt;は、行インスタンスページで定義されたインスタンスです。 &lt;ROW_INSTANCE&gt;.delete(completion: @escaping( ZCatalystError? ) -> Void) **パラメータ**: * **completion**: 操作が成功した場合、completionブロックは削除された行の詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットは以下の通りです: ZCatalystApp.shared.getDataStoreInstance().getTableInstance(id: 1096000000002071).getRow(id: 3376000000171021){(result)in //これをあなたのROWIDに置き換えてください switch result { case .success ( let row) : row.delete() {( error ) in if let error = error{ print( "Error occurred &gt;&gt;&gt; \( error )" ) } else { print("Row is successfully deleted.") } } case .error(let error) : print("Error occurred &gt;&gt;&gt; \( error )") } } ##### File Store -------------------------------------------------------------------------------- title: "File Storeインスタンスの作成" description: "Catalyst File Storeは、Catalystアプリケーションのアプリデータファイルおよびユーザーデータファイルのストレージソリューションを提供し、共有データへのアクセスを可能にします。" last_updated: "2026-06-10T06:04:54.157Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/file-store/create-file-store-instance/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - File Store - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder) -------------------------------------------------------------------------------- # File Store 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 Catalyst File Storeは、Catalystアプリケーションのアプリケーションファイルおよびユーザーデータファイルのクラウドストレージソリューションを提供し、共有データへのアクセスを可能にします。画像、動画、テキストファイル、ドキュメントファイル、スプレッドシート、またはその他の形式のファイルを保存、管理、整理することができます。 ### File Storeインスタンスの作成 **getFileStoreInstance()**メソッドを使用して、CatalystプロジェクトのFile Storeのインスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。これにより、不要なサーバー呼び出しを防ぐことができます。 File Storeインスタンスは以下のように作成できます： ZCatalystApp.shared.getFileStoreInstance() -> ZCatalystFileStore -------------------------------------------------------------------------------- title: "フォルダの取得" description: "Catalyst File Storeは、Catalystアプリケーションのアプリデータファイルおよびユーザーデータファイルのストレージソリューションを提供し、共有データへのアクセスを可能にします。" last_updated: "2026-06-10T06:04:54.157Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/file-store/get-folders/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Get Folder - API (/ja/api/code-reference/cloud-scale/file-store/get-all-folders/#GetAllFolders) -------------------------------------------------------------------------------- # フォルダの取得 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 ### 特定のフォルダのメタデータを取得する 以下のコード構文に示すように、一意のFolder IDを引数として**getFolder()**メソッドに渡すことで、File Store内の特定のフォルダの詳細を取得できます。これにより、フォルダオブジェクトが取得され、フォルダの作成日、最終変更日、およびフォルダ内のファイルのメタ詳細などのメタデータを取得できます。 以下のコードで使用されている&lt;FILE_STORE_INSTANCE&gt;は、File Storeインスタンスページで定義されたインスタンスです。 &lt;FILE_STORE_INSTANCE&gt;.getFolder( id : Int64, completion : @escaping ( Result&lt; ZCatalystFolder, ZCatalystError &gt; ) -> Void ) **パラメータ**: * **id**: 取得するフォルダの一意のFolder ID * **completion**: 操作が成功した場合、completionブロックはフォルダの詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットを以下に示します： ZCatalystApp.shared.getFileStoreInstance().getFolder(id : 3376000000427654) {(result) in //これをあなたのフォルダIDに置き換えてください switch result { case .success ( let folder) : print("The names of the folder are " + folder.name) case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } ### すべてのフォルダのメタデータを取得する 以下のコード構文に示すように、**getFolders()**メソッドを使用して、プロジェクトのFile Storeで利用可能なすべてのフォルダの詳細を取得できます。これにより、すべてのフォルダおよびフォルダ内のファイルのメタデータを取得できます。 以下のコードで使用されている&lt;FILE_STORE_INSTANCE&gt;は、File Storeインスタンスページで定義されたインスタンスです。 &lt;FILE_STORE_INSTANCE&gt;.getFolders( completion : @escaping ( Result&lt; [ ZCatalystFolder ], ZCatalystError &gt; ) -> Void ) **パラメータ**: * **completion**: 操作が成功した場合、completionブロックはすべてのフォルダの詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットを以下に示します： ZCatalystApp.shared.getFileStoreInstance().getFolders() {(result) in switch result{ case .success ( let folders) : for folder in folders { print("The names of the folder are " + folder.name) } case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } -------------------------------------------------------------------------------- title: "フォルダインスタンスの作成" description: "File Store内の特定のフォルダのインスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。" last_updated: "2026-06-10T06:04:54.157Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/file-store/create-folder-instance/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - File Store - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder) -------------------------------------------------------------------------------- # フォルダインスタンスの作成 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 **getFolderInstance()**メソッドを使用して、Catalyst File Store内の特定のフォルダのインスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。以下のコード構文に示すように、getFolderInstance()メソッドにそのフォルダのFolder IDを渡す必要があります。 以下のコードで使用されている&lt;FILE_STORE_INSTANCE&gt;は、File Storeインスタンスページで定義されたインスタンスです。 &lt;FILE_STORE_INSTANCE&gt;.getFolderInstance( id : Int64 ) -> ZCatalystFolder **パラメータ**: * **id**: インスタンスオブジェクトを返す対象のフォルダの一意のFolder ID サンプルコードスニペットを以下に示します： let folderInstance = ZCatalystApp.shared.getFileStoreInstance().getFolderInstance(id : 3376000000427654) //これをあなたのフォルダIDに置き換えてください -------------------------------------------------------------------------------- title: "ファイルの取得" description: "File Store内の特定のファイルまたはすべてのファイルの詳細を取得できます。" last_updated: "2026-06-10T06:04:54.159Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/file-store/get-files/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Get File - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-file/#GetSpecificFile) -------------------------------------------------------------------------------- # ファイルの取得 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 ### 特定のファイルのメタデータを取得する 以下のコード構文に示すように、一意のFile IDを引数として**getFile()**メソッドに渡すことで、File Store内の特定のファイルの詳細を取得できます。これにより、ファイルオブジェクトが取得され、ファイルの作成日、最終変更日、ファイルサイズなどのメタデータを取得できます。 以下のコードで使用されている&lt;FOLDER_INSTANCE&gt;は、フォルダインスタンスページで定義されたインスタンスです。 &lt;FOLDER_INSTANCE&gt;.getFile( fileId : Int64, completion : @escaping ( Result&lt; ZCatalystFile, ZCatalystError &gt; ) -> Void ) **パラメータ**: * **id**: 取得するファイルの一意のFile ID * **completion**: 操作が成功した場合、completionブロックはファイルの詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットを以下に示します： ZCatalystApp.shared.getFileStoreInstance().getFolderInstance(id : 105000000121098) .getFile(fileId : 332000000044009){(result) in //これをあなたのフォルダIDに置き換えてください and File ID switch result { case .success ( let file) : print("The name of the file is " + file.name) case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } ### すべてのファイルのメタデータを取得する 以下のコード構文に示すように、**getFiles()**メソッドを使用して、特定のフォルダ内で利用可能なすべてのファイルの詳細を取得できます。 以下のコードで使用されている&lt;FOLDER_INSTANCE&gt;は、フォルダインスタンスページで定義されたインスタンスです。 &lt;FOLDER_INSTANCE&gt;.getFiles( completion : @escaping ( Result&lt; [ ZCatalystFile ], ZCatalystError &gt; ) -> Void ) **パラメータ**: * **completion**: 操作が成功した場合、completionブロックはすべてのファイルの詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットを以下に示します： ZCatalystApp.shared.getFileStoreInstance().getFolderInstance(id : 105000000121098) .getFiles {(result) in //これをあなたのフォルダIDに置き換えてください switch result { case .success ( let files) : for file in files{ print("The names of the folder are \(file.name)") } case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } -------------------------------------------------------------------------------- title: "ファイルのアップロード" description: "File Store内の既存のフォルダにファイルをアップロードできます。" last_updated: "2026-06-10T06:04:54.159Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/file-store/upload-file/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Upload File - API (/ja/api/code-reference/cloud-scale/file-store/upload-file-in-folder/#UploadFileInaFolder) -------------------------------------------------------------------------------- # ファイルのアップロード 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 File Store内の既存のフォルダにファイルをアップロードできます。フォルダにファイルがアップロードされると、一意のFile IDが生成されます。画像、テキストドキュメント、CSV、またはその他の種類のファイルを最大100MBのファイルサイズまでアップロードできます。 以下で説明するいずれかの方法でファイルをアップロードできます。以下のすべてのメソッドのコードセクションで使用されている&lt;FOLDER_INSTANCE&gt;は、フォルダインスタンスページで定義されたインスタンスです。これは、ファイルをアップロードするフォルダを参照します。 ### Delegateを使用する方法 Delegateを使用して、指定されたフォルダインスタンスのフォルダにファイルをアップロードできます。これは2つの方法で実行できます： #### i. ファイルパスを渡す方法 File Reference IDとファイルパスをDelegateメソッドオブジェクトとともにupload()メソッドの引数として渡すことができます： &lt;FOLDER_INSTANCE&gt;.upload( fileRefId : String, filePath : URL, fileUploadDelegate : ZCatalystFileUploadDelegate ) **パラメータ**: * **fileRefId**: 特定のアップロードタスクを識別するための一意の参照IDです。タスクが正常に完了した後、Delegateメソッドで返されます。 * **filePath**: ローカルシステム内のアップロードするファイルのファイルパスです。 * **fileUploadDelegate**: ZCatalystFileUploadDelegate型のインスタンスです。 サンプルコードスニペットを以下に示します： func progress(fileRefId: String, session: URLSession, sessionTask: URLSessionTask, progressPercentage: Double, totalBytesSent: Int64, totalBytesExpectedToSend: Int64) { print("The percentage of file upload is \(progressPercentage)") } func didFinish(fileRefId: String, fileDetails: ZCatalystFile) { print("The file with reference id " + fileRefId + " is successfully uploaded.") } func didFail(fileRefId: String, with error: ZCatalystError?) { print("The file with reference id " + fileRefId + " upload has been failed due to \(ZCatalystError.self)") } } let filePath = self.testBundle?.path( forResource : "companylogo", ofType : "jpeg" ) //ここにファイル名を入力してください let url = URL( fileURLWithPath : filePath! ) ZCatalystApp.shared.getFileStoreInstance().getFolderInstance( id : 2823000000006544 ).upload( fileRefId : fileRefId, filePath : url, fileUploadDelegate : self ) //これをあなたのフォルダIDに置き換えてください #### ii. ファイルデータを渡す方法 ファイルデータをDelegateメソッドオブジェクトとともにupload()メソッドの引数として渡すことができます： &lt;FOLDER_INSTANCE&gt;.upload( fileRefId : String, fileName : String, fileData : Data, fileUploadDelegate : ZCatalystFileUploadDelegate ) **パラメータ**: * **fileRefId**: 特定のアップロードタスクを識別するための一意の参照IDです。タスクが正常に完了した後、Delegateメソッドで返されます。 * **fileName**: アップロードするファイルの名前です。 * **fileData**: Data型のファイルの内容です。 * **fileUploadDelegate**: ZCatalystFileUploadDelegate型のインスタンスです。 サンプルコードスニペットを以下に示します： func progress(fileRefId: String, session: URLSession, sessionTask: URLSessionTask, progressPercentage: Double, totalBytesSent: Int64, totalBytesExpectedToSend: Int64) { print("The percentage of file upload is \(progressPercentage)") } func didFinish(fileRefId: String, fileDetails: ZCatalystFile) { print("The file with reference id " + fileRefId + " is successfully uploaded.") } func didFail(fileRefId: String, with error: ZCatalystError?) { print("The file with reference id " + fileRefId + " upload has been failed due to \(ZCatalystError.self)") } } if let data = image?.pngData() ZCatalystApp.shared.getFileStoreInstance().getFolderInstance( id : 105000000121098 ).upload( fileRefId : "1234567", fileName : url.lastPathComponent, fileData: data, fileUploadDelegate : self ) //ここにファイル参照IDを入力してください ### Completion Handlerを使用する方法 Completion Handlerを使用して、指定されたフォルダインスタンスのフォルダにファイルをアップロードできます。これは2つの方法で実行できます： #### i. ファイルパスを渡す方法 ファイルパスをCompletion Handlerとともにupload()メソッドの引数として渡すことができます： &lt;FOLDER_INSTANCE&gt;.upload( filePath : URL, completion : @escaping ( Result&lt; ZCatalystFile, ZCatalystError &gt; ) -> Void ) **パラメータ**: * **filePath**: ローカルシステム内のアップロードするファイルのファイルパスです。 * **completion**: 操作が成功した場合、completionブロックはアップロードされたファイルの詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットを以下に示します： let filePath = self.testBundle?.path( forResource : "document", ofType : "jpeg" ) //ここにファイル名を入力してください let url = URL( fileURLWithPath : filePath! ) ZCatalystApp.shared.getFileStoreInstance().getFolderInstance( id : 105000000121098 ).upload( filePath : url) { ( fileResult ) in //これをあなたのフォルダIDに置き換えてください switch fileResult{ case .success (let file) : print ("Image has been successfully uploaded and it's id is " + file.id) case .error(let error) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } #### ii. ファイルデータを渡す方法 ファイルデータをCompletion Handlerとともにupload()メソッドの引数として渡すことができます： &lt;FOLDER_INSTANCE&gt;.upload( fileName : String, fileData : Data, completion: @escaping (Result&lt;ZCatalystFile, ZCatalystError&gt;) -> Void ) **パラメータ**: * **fileName**: アップロードするファイルの名前です。 * **fileData**: Data型のファイルの内容です。 * **completion**: 操作が成功した場合、completionブロックはアップロードされたファイルの詳細を返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットを以下に示します： let image = UIImage ( named : "document" ) //ファイル名をここに置き換えてください if let data = image?.pngData(){ ZCatalystApp.shared.getFileStoreInstance().getFolderInstance(id: 105000000121098).upload(fileName: "document", fileData: data, fileRefId : "123456789983") { (result) in //ファイル名とファイル参照IDをここに置き換えてください switch result{ case .success (let file) : print ("Image has been successfully uploaded and it's id is \(file.id)") case .error(let error) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } } -------------------------------------------------------------------------------- title: "ファイルのダウンロード" description: "File Store内の既存のフォルダからファイルをダウンロードできます。" last_updated: "2026-06-10T06:04:54.159Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/file-store/download-file/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) - File Store Implementation (/ja/cloud-scale/help/file-store/implementation) - Download File - API (/ja/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder) -------------------------------------------------------------------------------- # ファイルのダウンロード 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 **download()**メソッドを呼び出すことで、File Store内の既存のフォルダからファイルをダウンロードできます。操作はファイルが保存されている一時URLを返します。 以下に示す2つの方法のいずれかでファイルをダウンロードできます。 両方のコードセクションで使用されている&lt;FILE_INSTANCE&gt;は、サンプルコードスニペットに示すように、特定のファイルに対して作成されたインスタンスです。これは、ダウンロードする特定のフォルダのファイルを参照します。 ### Delegateを使用する方法 このメソッドでは、以下のコード構文に示すように、Delegateを使用してファイルがダウンロードされます： &lt;FILE_INSTANCE&gt;.download( fileDownloadDelegate : ZCatalystFileDownloadDelegate ) **パラメータ**: * **FileDownloadDelegate**: ZCatalystFileDownloadDelegate型のインスタンスです。 サンプルコードスニペットを以下に示します： func progress(fileRefId: String, session: URLSession, downloadTask: URLSessionDownloadTask, progressPercentage: Double, totalBytesWritten: Int64, totalBytesExpectedToWrite: Int64) { print("The percentage of file download is \(progressPercentage)") } func didFinish( fileRefId : String, fileResult : ( Data, URL ) ) { print("The file with reference id " + fileRefId + " is successfully downloaded.") } func didFail( fileRefId : String, with error : ZCatalystError? ) { print("The file with reference id " + fileRefId + " download has been failed due to \(ZCatalystError.self)") } ZCatalystApp.shared.getFileStoreInstance().getFolderInstance(id : 105000000121098) .getFile(id : 332000000044009){(result) in //フォルダIDとファイルIDをここに置き換えてください switch result{ case .success ( let file) : file.download( fileDownloadDelegate : self ) case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } ### Completion Handlerを使用する方法 このメソッドでは、以下のコード構文に示すように、Completion Handlerを使用してファイルがダウンロードされます： &lt;FILE_INSTANCE&gt;.download( completion : @escaping ( Result&lt; ( Data, URL ), ZCatalystError &gt; ) -> Void ) **パラメータ**: * **completion**: 操作が成功した場合、completionブロックはファイルデータとファイルデータが保存されている一時URLを返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットを以下に示します： ZCatalystApp.shared.getFileStoreInstance().getFolderInstance(id: 105000000121098).getFile(fileId: 332000000044009) {(result) in //これをあなたのフォルダIDに置き換えてください and File ID switch result{ case .success(let file) : file.download(){(result) in switch result{ case .success(let downloaded_file) : print("The file is successfully downloaded.") case .error(let error) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } case .error(let error) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } ##### Stratus -------------------------------------------------------------------------------- title: "概要" description: "このページでは、Stratus操作を実行するために必要なモバイルSDKメソッドの概要を提供します。" last_updated: "2026-06-10T06:04:54.160Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/stratus/overview/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/overview/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/overview/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/overview/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v1/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # 概要 Cloud Scale Stratusは、Catalystの堅牢で強力なストレージソリューションです。Bucketと呼ばれるコンテナに、Objectの形式で任意の形式のデータを保存できます。各Bucketおよびバケット内の個々のオブジェクトには、安全なObject URLとBucket URLがあります。オブジェクトに対してアップロードおよびダウンロード操作を実行でき、各オブジェクトにカスタム権限を提供することもできます。 以下の表には、コードを通じてStratus操作を実行するために使用できるすべてのCatalyst SDKのリストが含まれています。 <table class="content-table"> <thead> <tr> <th class="w30p">カテゴリ</th> <th class="w70p">SDKメソッド</th> </tr> </thead> <tbody> <tr> <td>一般的なStratus操作</td> <td> <ul> <li>Bucketインスタンスの作成</li> </ul> </td> </tr> <tr> <td>Bucket操作</td> <td> <ul> <li>Objectの取得 <ul> <li>すべてのObjectの取得</li> </ul> </li> <li>Objectのダウンロード <ul> <li>Objectのダウンロード（Completion Callback）</li> <li>Objectのダウンロード（進捗付き）</li> </ul> </li> <li>Objectのアップロード <ul> <li>パスを使用したObjectのアップロード（Completion Callback）</li> <li>ファイル名とファイルデータを使用したObjectのアップロード（Completion Callback）</li> <li>パスを使用したObjectのアップロード（進捗付き）</li> <li>ファイル名とファイルデータを使用したObjectのアップロード（進捗付き）</li> </ul> </li> <li>Objectの削除 <ul> <li>単一のObjectの削除</li> <li>複数のObjectの削除</li> </ul> </li> <li>パスの削除</li> </ul> </td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "Bucketインスタンスの作成" description: "このページでは、Bucketインスタンスを作成するためのiOS SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.160Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/stratus/create-bucket-instance/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/create-bucket-instance/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/create-bucket-instance/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/create-bucket-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/initialize-stratus-instance/#initialize-bucket-instance) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/) - Flutter SDK (/ja/sdk/flutter/v1/cloud-scale/stratus/initialize-stratus/#create-bucket-instance) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Bucketインスタンスの作成 Bucketレベルの操作を実行するには、Bucketインスタンスを初期化する必要があります。このコンポーネントインスタンスは、StratusのBucketを操作するさまざまなコードスニペットで参照されます。 let bucket = ZCatalystStratus.getBucketInstance( name : "{bucket_name}" ) -------------------------------------------------------------------------------- title: "Objectの取得" description: "このページでは、BucketからObjectまたはObjectを取得するためのiOS SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.160Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/stratus/get-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/get-objects/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/get-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/get-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/get-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/get-object/) - Flutter SDK (/ja/sdk/flutter/v1/cloud-scale/stratus/get-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-objects/#GetAllObjects) -------------------------------------------------------------------------------- # Objectの取得 このSDKメソッドは、BucketからObjectを取得するために使用できます。レスポンスは**blob**形式で返されます。 Bucketでバージョニングが有効になっている場合： * versionIdを渡さない場合、**最新のObject**のみが返されます。 * 特定のバージョンを取得するには、有効なバージョンを値としてversionIdクエリパラメータを使用します。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w30p">パラメータ名</th> <th class="w70p">定義</th> </tr> </thead> <tbody> <tr> <td>objectKey</td> <td>必須パラメータです。Object名を含みます。</td> </tr> <tr> <td>versionId</td> <td>オプションパラメータです。必要なObjectのバージョンの一意のバージョンIDを保持します。</td> </tr> </tbody> </table> bucketInstance.getObject( objectKey : "{object_name}", versionId : "{version_id}" ) { result in switch result { case .success( let object ) : print( "File Name : \( object.fileName )" ) case .error(let error) : print("Error : \( error )") } } 必要なObjectが返されます。 **発生する可能性のある例外** * **404**: ObjectまたはBucketが見つかりません ### すべてのObjectの取得 このSDKメソッドは、ページネーション技術を使用してBucket内に存在するすべてのObjectを取得するために使用できます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>prefix</td> <td>String</td> <td>オプションパラメータです。プレフィックス値に一致するObjectを取得します。</td> </tr> <tr> <td>maxKeys</td> <td>Number</td> <td>オプションパラメータです。ページネーションで一覧表示できるObjectの最大数を含みます。</td> </tr> <tr> <td>continuation_token</td> <td>String</td> <td>オプションパラメータです。レスポンスが切り捨てられた場合、次のObjectのセットを取得するために、このキーの値を同じメソッドにcontinuation_tokenとして渡す必要があります。</td> </tr> </tbody> </table> var params = ZCatalystQuery.ObjectParams() params.maxKeys = 10 params.continuationToken = "{continuation_token}" parmas.prefix = "{prefix}" bucketInstance.getObjects( withParams : params ) { result in switch result { case .success( let objects, let response ) : for object in objects { print("File Name : \( object.fileName )") } case .error( let error ) : print("Error : \( error )") } } 必要なObjectがBlob形式の配列として返されます。 **発生する可能性のある例外** * **404**: ObjectまたはBucketが見つかりません -------------------------------------------------------------------------------- title: "Objectのダウンロード" description: "このページでは、BucketにObjectをダウンロードするためのiOS SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.160Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/stratus/download-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Download an Object (/ja/cloud-scale/help/stratus/objects/manage-object/download-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/range-download/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/range-download/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/range-download/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/range-download/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/download-object/) - Flutter SDK (/ja/sdk/flutter/v1/cloud-scale/stratus/download-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/download-object/#DownloadObject) -------------------------------------------------------------------------------- # Objectのダウンロード 以下のSDKメソッドを使用して、Objectをダウンロードできます。 ### Objectのダウンロード（Completion Callback） このSDKメソッドを使用すると、進捗インジケーターなしでObjectをダウンロードできます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w30p">パラメータ名</th> <th class="w70p">定義</th> </tr> </thead> <tbody> <tr> <td>fromCache</td> <td> <ul> <li>オプションパラメータです。このファイルをキャッシュから取得するかどうかを指定するために使用します。</li> <li>デフォルト値: false。</li> </ul> </td> </tr> </tbody> </table> objectInstance.download( fromCache : true ) { result in switch result { case .success( let url ) : do { let data = Data(contentsOf : url) DispatchQueue.main.sync { self.imageView.image = UIImage(date: data) } } catch { print("Error : \( error )") } case .error( let error ) : print("Error : \( error )") } } ### Objectのダウンロード（進捗付き） このSDKメソッドを使用すると、進捗インジケーター付きでObjectをダウンロードできます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w30p">パラメータ名</th> <th class="w70p">定義</th> </tr> </thead> <tbody> <tr> <td>fromCache</td> <td> <ul> <li>オプションパラメータです。このファイルをキャッシュから取得するかどうかを指定するために使用します。</li> <li>デフォルト値: false。</li> </ul> </td> </tr> <tr> <td>fileRefId</td> <td>アップロード中のファイルを参照するための一意のIDです。</td> </tr> <tr> <td>fileUploadDelegate</td> <td>確認が必要なプロトコルです。Objectのアップロード状況を追跡するために、Upload Delegateオブジェクトが不可欠です。</td> </tr> </tbody> </table> objectInstance.download( fromCache : true, fileRefId : "{file_ref_id}", fileDownloadDelegate : self ) -------------------------------------------------------------------------------- title: "Objectのアップロード" description: "このページでは、BucketにObjectをアップロードするためのiOS SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.160Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/stratus/upload-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Upload Object Help Documentation (/ja/cloud-scale/help/stratus/objects/upload-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/upload-object/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/upload-object/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/upload-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/upload-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/upload-object/) - Flutter SDK (/ja/sdk/flutter/v1/cloud-scale/stratus/upload-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/upload-object/#UploadObject) -------------------------------------------------------------------------------- # Objectのアップロード このセクションに記載されているSDKメソッドを使用すると、BucketにObjectをアップロードできます。 Objectに対してバージョニングが有効になっていない場合、Stratusが同じObjectに対して複数の書き込みリクエストを受信すると、Objectは継続的に上書きされます。Objectの最新のアップロードのみが保存されます。 ただし、バージョニングが有効な場合、各アップロードはObjectのバージョンとして扱われ、すべてがBucketに保存され、それぞれに一意のversionIdが付与されます。 注意: パスやObjectを作成する際、スペースを含む以下の文字はサポートされていません：ダブルクォート、両方の山括弧、ハッシュタグ、バックスラッシュ、およびパイプ記号。 ### パスを使用したObjectのアップロード（Completion Callback） このSDKは、パスを使用してBucketにObjectをアップロードするために使用できます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w30p">パラメータ名</th> <th class="w70p">定義</th> </tr> </thead> <tbody> <tr> <td>filePath</td> <td>必須パラメータです。ファイルのアップロード元の完全なパスを含みます。</td> </tr> <tr> <td>fileName</td> <td> <ul> <li>オプションパラメータです。Objectの完全な名前を保持します。</li> <li>デフォルト値: 使用された最後のパス値を保持します。</li> </ul> </td> </tr> <tr> <td>shouldCompress</td> <td> <ul> <li>オプションパラメータです。Objectを圧縮するかどうかを選択できます。</li> <li>デフォルト値: false。</li> </ul> </td> </tr> </tbody> </table> bucketInstance.upload( filePath : "{file_path}", fileName : "{file_name}", shouldCompress : true ) { error in if let error = error { print("Error : \( error )") return } print("Uploaded Successfully") } ### ファイル名とファイルデータを使用したObjectのアップロード（Completion Callback） このSDKは、名前とデータ形式を使用してBucketにObjectをアップロードするために使用できます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w30p">パラメータ名</th> <th class="w70p">定義</th> </tr> </thead> <tbody> <tr> <td>fileName</td> <td>必須パラメータです。アップロードするObjectの完全な名前を含みます。</td> </tr> <tr> <td>data</td> <td>必須パラメータです。データ形式でアップロードするObjectです。</td> </tr> <tr> <td>shouldCompress</td> <td> <ul> <li>オプションパラメータです。Objectを圧縮するかどうかを選択できます。</li> <li>デフォルト値: false。</li> </ul> </td> </tr> </tbody> </table> bucketInstance.upload( fileName : "{file_name}", data : "{file_data}", shouldCompress : false ) { error in if let error = error { print("Error : \( error )") return } print("Uploaded Successfully") } ### パスを使用したObjectのアップロード（進捗付き） このSDKは、パスを使用してBucketにObjectをアップロードするために使用できます。このSDKメソッドはアップロードの進捗インジケーターも提供します。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w30p">パラメータ名</th> <th class="w70p">定義</th> </tr> </thead> <tbody> <tr> <td>fileRefId</td> <td>アップロード中のファイルを参照するための一意のIDです。</td> </tr> <tr> <td>filePath</td> <td>必須パラメータです。ファイルのアップロード先の完全なパスを含みます。</td> </tr> <tr> <td>fileName</td> <td> <ul> <li>オプションパラメータです。Objectの完全な名前を保持します。</li> <li>デフォルト値: 使用された最後のパス値を保持します。</li> </ul> </td> </tr> <tr> <td>shouldCompress</td> <td> <ul> <li>オプションパラメータです。Objectを圧縮するかどうかを選択できます。</li> <li>デフォルト値: false。</li> </ul> </td> </tr> <tr> <td>fileUploadDelegate</td> <td>確認が必要なプロトコルです。Objectのアップロード状況を追跡するために、Upload Delegateオブジェクトが不可欠です。</td> </tr> </tbody> </table> bucketInstance.upload( fileRefId : "{file_ref_id}", filePath : "{file_path}", fileName : "{file_name}", shouldCompress : true, fileUploadDelegate : self ) ### ファイル名とファイルデータを使用したObjectのアップロード（進捗付き） このSDKは、名前とデータ形式を使用してBucketにObjectをアップロードするために使用できます。このSDKメソッドはアップロードの進捗インジケーターも提供します。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w30p">パラメータ名</th> <th class="w70p">定義</th> </tr> </thead> <tbody> <tr> <td>fileRefId</td> <td>アップロード中のファイルを参照するための一意のIDです。</td> </tr> <tr> <td>data</td> <td>必須パラメータです。データ形式でアップロードするObjectです。</td> </tr> <tr> <td>fileName</td> <td> <ul> <li>オプションパラメータです。Objectの完全な名前を保持します。</li> <li>デフォルト値: 使用された最後のパス値を保持します。</li> </ul> </td> </tr> <tr> <td>shouldCompress</td> <td> <ul> <li>オプションパラメータです。Objectを圧縮するかどうかを選択できます。</li> <li>デフォルト値: false。</li> </ul> </td> </tr> <tr> <td>fileUploadDelegate</td> <td>確認が必要なプロトコルです。Objectのアップロード状況を追跡するために、Upload Delegateオブジェクトが不可欠です。</td> </tr> </tbody> </table> bucketInstance.upload( fileRefId : "{file_ref_id}", fileName : "{file_name}", data : "{file_data}", shouldCompress : true, fileUploadDelegate : self) -------------------------------------------------------------------------------- title: "Objectの削除" description: "このページでは、BucketからObjectまたはObjectを削除するためのiOS SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.160Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/stratus/delete-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Delete an Object Help Documentation (/ja/cloud-scale/help/stratus/objects/manage-object/delete-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/delete-objects/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/delete-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/delete-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/delete-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/delete-object/) - Flutter SDK (/ja/sdk/flutter/v1/cloud-scale/stratus/delete-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/delete-objects/#DeleteObject) -------------------------------------------------------------------------------- # Objectの削除 ### 単一のObjectの削除 以下のSDKメソッドを使用して、Bucketから単一のObjectを削除できます。 objectInstance.delete() { error in if let error = error { print("Error : \( error )") return } print("Deleted Successfully") } ### 複数のObjectの削除 以下のSDKメソッドを使用して、Bucketから複数のObjectを削除できます。 bucketInstance.deleteObjects( deletableObjectInstances ) { error in if let error = error { print("Error : \( error )") return } print("Deleted Successfully") } -------------------------------------------------------------------------------- title: "パスの削除" description: "このページでは、Bucketからパス全体とそのObjectを削除するためのiOS SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.161Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/stratus/delete-path/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Delete an Object Help Documentation (/ja/cloud-scale/help/stratus/objects/manage-object/delete-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/delete-objects/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/delete-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/delete-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/delete-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/delete-path/) - Flutter SDK (/ja/sdk/flutter/v1/cloud-scale/stratus/delete-path/) - REST API (/ja/api/code-reference/cloud-scale/stratus/delete-path/#DeletePath) -------------------------------------------------------------------------------- # パスの削除 以下のSDKメソッドを使用して、指定されたパス内に存在するすべてのObjectを削除できます。 bucketInstance.deletePath("{path_to_be_deleted}") { error in if let error = error { print("Error : \( error )") return } print("Path Deleted Successfully") } ##### ZCQL -------------------------------------------------------------------------------- title: "ZCQLクエリの実行" description: "ZCQLは、Data Storeでのデータの作成、取得、および変更操作を可能にするCatalyst独自のクエリ言語です。" last_updated: "2026-06-10T06:04:54.161Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/zcql/execute-zcql-query/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - ZCQL (/ja/cloud-scale/help/zcql/introduction/) - Execute ZCQL - API (/ja/api/code-reference/cloud-scale/zcql/execute-zcql-query/#ExecuteZCQLQuery) -------------------------------------------------------------------------------- # ZCQL ZCQLは、Data Storeでのデータ取得操作を可能にするCatalyst独自のクエリ言語です。組み込み関数、SQL Joinクローズ、およびその他のステートメントと条件を持つSELECTクエリをサポートしています。 ### ZCQLクエリの実行 必要なデータセットを取得するためにZCQLクエリを実行する前に、**execute()**メソッドに渡すクエリを構築する必要があります。ZCQLの構文については、ZCQLヘルプページから学ぶことができます。 以下のZCQLクエリ実行のコード構文に示すように、execute()メソッドに**ZCatalystSelectQuery**のインスタンスを渡す必要があります。 &lt;ZCatalystApp&gt;.execute( query : ZCatalystSelectQuery, completion: @escaping (Result&lt;[ [ String : Any ] ], ZCatalystError&gt;) -> Void) **パラメータ**: * **query**: 渡すZCatalystSelectQuery型のインスタンスです。 * **completion**: クエリ実行の呼び出しが成功した場合、completionブロックはクエリの条件に一致するレコードを返します。それ以外の場合は、エラーを返します。 ZCQLがサポートするステートメントのZCatalystSelectQueryのqueryインスタンスを以下の方法で作成できます： ZCatalystSelectQuery.Builder() .select(columns: Set&lt;Column&gt;) -> ZCatalystSelectQuery.Builder .selectAll() -> ZCatalystSelectQuery.Builder .where(column: String, comparator: Comparator, value: String) -> ZCatalystSelectQuery.Builder .from(tableName: String) -> ZCatalystSelectQuery.Builder .and(column: String, comparator: Comparator, value: String) -> ZCatalystSelectQuery.Builder .groupBy(columns: Set&lt;Column&gt;) -> ZCatalystSelectQuery.Builder .orderBy(columns: Set&lt;Column&gt;, sortOrder: SortOrder) -> ZCatalystSelectQuery.Builder .innerJoin(tableName: String) -> ZCatalystSelectQuery.Builder .leftJoin(tableName: String) -> ZCatalystSelectQuery.Builder .on(joinColumn1: String, comparator: Comparator, joinColumn2: String) -> ZCatalystSelectQuery.Builder .or(column: String, comparator: Comparator, value: String) -> ZCatalystSelectQuery.Builder .limit(offset: Int, value: Int? = nil) -> ZCatalystSelectQuery.Builder .build() -> ZCatalystSelectQuery ZCQLクエリ実行のサンプルコードスニペットを以下に示します： func testExecuteZCQL(){ var builder = ZCatalystSelectQuery.Builder() var query = builder.selectAll().from( tableName : "Bio-data" ).build() //ここにテーブル名を入力してください ZCatalystApp.shared.getDataStoreInstance(tableIdentifier: "1096000000002071").execute( query : query) { ( result ) in switch result{ case .success( let response ) : print("Response : \( response )") case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } } ##### プッシュ通知 -------------------------------------------------------------------------------- title: "プッシュ通知のためのデバイス登録" description: "このページでは、iOSアプリを登録してCatalystプッシュ通知に申し込んだ後、リモートプッシュ通知のためにiOSデバイスを登録するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.164Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/push-notifications/register-device/" service: "Cloud Scale" related: - Push Notifications (/ja/cloud-scale/help/push-notifications/introduction) - iOS Push Notifications (/ja/cloud-scale/help/push-notifications/ios) - Push Notifications API for iOS Devices (/ja/api/code-reference/cloud-scale/push-notifications/ios/send-ios-push-notifications/#SendiOSPushNotifications) - Push Notifications Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/push-notifications/register-device/) -------------------------------------------------------------------------------- # Push Notifications ### はじめに Catalystプッシュ通知は、アプリがユーザーデバイスでアクティブに実行されていない場合でも、アプリケーションのユーザーにリモート通知を送信できるようにします。Catalystは、Catalystウェブ、iOS、およびAndroidアプリケーションにプッシュ通知を統合する簡単な方法を提供します。 プッシュ通知を送信する前に、アプリを登録してCatalystプッシュ通知に申し込むための一連の手順に従う必要があります。以下に手順を順序通りに示します： 1. AppleにiOSアプリを登録する 2. キーチェーンアクセスから証明書を生成する 3. Appleが提供するAPNs証明書を生成してダウンロードする 4. ダウンロードしたAPNs証明書を.p12形式に変換する 5. CatalystでiOSプッシュ通知サービスに申し込む 6. プッシュ通知用のモバイルデバイスを登録する 注意: 最初の5つの手順は、プッシュ通知 - iOSヘルプセクションで詳しく説明されています。このiOS SDKヘルプドキュメントでは、プッシュ通知を送信するためのデバイス登録に関する6番目の手順と、デバイスの登録解除についてのみ説明しています。以下のコードを使用する前に、プッシュ通知ヘルプドキュメントを参照して手順1～5を実装できます。 <br> ### プッシュ通知用のモバイルデバイスを登録する 上記の最初の5つの手順を完了した後、iOSアプリに以下のコードを実装して、Catalystプッシュ通知用のデバイスを登録できます。 テストデバイスとしてiOSモバイルデバイスを登録するには、以下のコードスニペットに示すように、必要なパラメータを指定してregisterNotification()メソッドを呼び出す必要があります： ZCatalystApp.shared.registerNotification(token: e5********21, appID: 12345678, testDevice: false) { error in if let error = error { return print("Error : \( error )") } print("Registered successfully") } **パラメータ:** * token: APNSでリモートプッシュ通知用にデバイスを登録した後に取得されるデバイストークンです。 * appID: CatalystにiOSアプリを登録した際にCatalystがアプリ用に生成するAppConfigurationDevelopment.plist/ AppConfigurationProduction.plistファイルから取得されるnotificationAppIDです。 * testDevice: テストデバイスの場合はtrueに設定し、本番デバイスの場合はfalseに設定します。 <br> 注意: iOSプッシュ通知をテストするために、最大10台のiOSデバイスをテストデバイスとして登録できます。 デバイスが登録されると、アプリユーザーにプッシュ通知を送信できるようになります。ユーザーは、デバイスに表示される許可プロンプトから**許可**をクリックして、アプリがプッシュ通知を送信する許可を提供する必要があります。 登録済みデバイスへのテストプッシュ通知の送信については、こちらのヘルプセクションからCatalystコンソールでの方法を確認できます。また、APIからテスト通知を送信することもできます。 コードベースを通じてプッシュ通知を送信する方法については、Java、Node.js、およびPython SDKドキュメントを参照してください。 -------------------------------------------------------------------------------- title: "プッシュ通知のためのデバイス登録解除" description: "このページでは、リモートプッシュ通知に登録済みのiOSデバイスを登録解除するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.164Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/push-notifications/deregister-device/" service: "Cloud Scale" related: - Push Notifications (/ja/cloud-scale/help/push-notifications/introduction) - iOS Push Notifications (/ja/cloud-scale/help/push-notifications/ios) - Push Notifications API for iOS Devices (/ja/api/code-reference/cloud-scale/push-notifications/ios/send-ios-push-notifications/#SendiOSPushNotifications) -------------------------------------------------------------------------------- # プッシュ通知のためのモバイルデバイスの登録解除 以下に示すように、必要なパラメータをderegisterNotification()メソッドに渡すことで、Catalyst iOSプッシュ通知に登録されたデバイスの登録を解除できます。 ZCatalystApp.shared.deregisterNotification(token: e5********21, appID: 1234567, testDevice: true) { error in if let error = error { return print("Error : \( error )") } print("UnRegistered successfully") } **パラメータ:** * token: token: APNSでリモートプッシュ通知用にデバイスを登録した後に取得されるデバイストークンです。 * appID: CatalystにiOSアプリを登録した際にCatalystがアプリ用に生成するAppConfigurationDevelopment.plist/ AppConfigurationProduction.plistファイルから取得されるnotificationAppIDです。 * testDevice: テストデバイスの場合はtrueに設定し、本番デバイスの場合はfalseに設定します。 ##### 検索 -------------------------------------------------------------------------------- title: "テーブル内のデータ検索" description: "Catalyst Searchは、Data Store内のテーブルのインデックス付きカラムでのデータ検索を可能にします。単一の検索クエリで大量のデータに対して強力な検索を実行できます。" last_updated: "2026-06-10T06:04:54.164Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/search/search-data-in-tables/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Search (/ja/cloud-scale/help/search-integration/introduction) - Search - API (/ja/api/code-reference/cloud-scale/search/execute-search-query/#ExecuteSearchQuery) -------------------------------------------------------------------------------- # Search Catalyst Searchは、Data Store内のテーブルのインデックス付きカラムでのデータ検索を可能にします。単一の検索クエリで大量のデータに対して強力な検索を実行できます。 ### テーブル内のデータ検索 **search()**メソッドは、特定のパターンでテーブル内のデータを検索するために使用されます。検索操作を実行する前に、以下のコード構文に示すように、search()メソッドに渡す検索パターンを構築する必要があります： ZCatalystApp.shared.search( searchOptions : ZCatalystSearchOptions, completion : @escaping( Result&lt; [ String : Any ], ZCatalystError &gt; ) -> Void ) **パラメータ**: * **searchOptions**: search()メソッドに渡すZCatalystSearchOptionsクラスのインスタンスです。 * **completion**: 呼び出しが正常に実行された場合、completionブロックは検索結果のデータを返します。それ以外の場合は、エラーを返します。 以下の方法でsearchOptionsのインスタンスを作成できます： ZCatalystSearchOptions(searchText: String, searchColumns : [ TableColumns ]) .add(searchColumns : TableColumns) .add(displayColumns : TableColumns) .add(sortColumn : String, in table : String) TableColumns( tableName : String ) TableColumns.add( column : String ) 検索実行のサンプルコードスニペットを以下に示します： var searchColumns = ZCatalystSearchOptions.TableColumns( tableName : "EmployeeDetails" ) //これをあなたのテーブル名に置き換えてください searchColumns.add( column : "Age" ) //これをあなたの列名に置き換えてください var searchOptions = ZCatalystSearchOptions( searchText : "25", searchColumns : [ searchColumns ] ) //これをあなたの検索テキストに置き換えてください var displayColumns = ZCatalystSearchOptions.TableColumns( tableName : "EmployeeDetails" ) //これをあなたのテーブル名に置き換えてください displayColumns.add( column : "Age" ) //これをあなたの列名に置き換えてください searchOptions.add(displayColumns: displayColumns) ZCatalystApp.shared.search( searchOptions : searchOptions) { ( result ) in switch result{ case .success( let response ) : print("Response : \( response )") case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } ##### 認証 -------------------------------------------------------------------------------- title: "新しいユーザーインスタンスの作成" description: "Catalyst認証機能を使用すると、ユーザー認証を管理できます。不要なサーバー呼び出しを防ぐために、新しいユーザーインスタンスを作成できます。" last_updated: "2026-06-10T06:04:54.164Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/authentication/create-user-instance/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Add New User - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # Authentication Catalyst Authenticationは、Catalyst Cloud Scaleのコンポーネントであり、アプリケーションにエンドユーザーを追加し、アプリのログインおよびサインアップフォームをカスタマイズし、ユーザーアカウントとロールを管理し、アプリケーション全体のセキュアなアクセスを確保できます。 ## 新しいユーザーインスタンスの作成 新しいユーザーインスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。これにより、不要なサーバー呼び出しを防ぐことができます。 以下のコード構文に示すように、ユーザーの詳細を**newUser()**メソッドに渡す必要があります。インスタンスを正常に作成するには、ユーザーのメールアドレスと姓を必ず渡す必要があります。 ZCatalystApp.shared.newUser( lastName : String, email : String ) -> ZCatalystUser **パラメータ**: * **lastName**: 新しいユーザーの姓 * **email**: 招待メールが送信されるユーザーのメールアドレス サンプルコードスニペットは以下の通りです: ZCatalystApp.shared.newUser( lastName : "Burrows", email : "emma@zylker.com" ) -> ZCatalystUser -------------------------------------------------------------------------------- title: "ユーザーサインアップ" description: "Catalystアプリケーションに新しいユーザーを追加します。" last_updated: "2026-06-10T06:04:54.164Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/authentication/user-signup/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Authentication - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # ユーザーサインアップ signUp()メソッドを呼び出すことで、Catalystアプリに新しいユーザーを追加できます。こちらで定義されたユーザーインスタンスを**signUp()**メソッドの引数として渡す必要があります。 ユーザーサインアップのコード構文は以下の通りです: ZCatalystApp.shared.signUp(user: ZCatalystUser, completion: @escaping (Result&lt;( ZCatalystUser, Int64 ), ZCatalystError &gt;) -> Void) **パラメータ**: * **user**: この操作の前に作成されたユーザーインスタンス * **completion**: 呼び出しが正常に実行された場合、completionブロックはユーザーに割り当てられたUserID、ZUID、Org IDなどを含むユーザーオブジェクトを返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットは以下の通りです: let userobj = ZCatalystApp.shared.newUser( lastName : "McRogan", email : "timothy.mcrogan@zylker.com") //ユーザーの姓とメールアドレスに置き換えてください ZCatalystApp.shared.signUp(user: userobj) { ( result ) in switch result{ case .success ( let result ) : print("The user \(result.0.firstName) in org \(result.1) has been successfully signed up.") case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } -------------------------------------------------------------------------------- title: "ユーザーログイン" description: "Catalyst iOSアプリのエンドユーザーにログインページを表示できます。" last_updated: "2026-06-10T06:04:54.164Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/authentication/user-login/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Authentication - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # ユーザーログイン **showLogin()**メソッドを使用して、Catalyst iOSアプリのエンドユーザーにログインページを表示できます。これは、ユーザーがアプリからログアウトしている場合に表示されます。ログインに成功すると、ユーザーはアプリにアクセスできるようになります。 ユーザーログインのコード構文は以下の通りです: ZCatalystApp.shared.showLogin( completion : @escaping ( Error? ) -> Void ) ViewController.swift **パラメータ**: * **completion**: ログインが失敗した場合、completionブロックにエラーが渡されます。 -------------------------------------------------------------------------------- title: "ユーザーログアウト" description: "Catalyst iOSアプリからアプリユーザーをログアウトできます。" last_updated: "2026-06-10T06:04:54.165Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/authentication/user-logout/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Logout User - API (/ja/api/code-reference/cloud-scale/authentication/sign-out-user/#SignOutUser) -------------------------------------------------------------------------------- # ユーザーログアウト **logout()**メソッドを使用すると、Catalyst iOSアプリからアプリユーザーをログアウトできます。 ユーザーログアウトのコード構文は以下の通りです: ZCatalystApp.shared.logout( completion : @escaping ( Error? ) -> Void ) ViewController.swift **パラメータ**: * **completion**: ログアウトが失敗した場合、completionブロックにエラーが渡されます。 -------------------------------------------------------------------------------- title: "現在のユーザーの取得" description: "アプリケーションの現在のエンドユーザーの詳細を取得できます。" last_updated: "2026-06-10T06:04:54.165Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/authentication/get-current-user/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Users (/ja/cloud-scale/help/authentication/user-management/users/introduction/) - Get Current User - API (/ja/api/code-reference/cloud-scale/authentication/get-current-user/#GetCurrentUser) -------------------------------------------------------------------------------- # 現在のユーザーの取得 **getCurrentUser()**メソッドを呼び出すことで、アプリケーションの現在のエンドユーザーの詳細を取得できます。正常に実行されると、このメソッドは現在のユーザーオブジェクトを返します。これを使用して、Catalystに登録されているユーザーの名前、姓、メールアドレスなどの詳細を取得できます。 現在のユーザーを取得するためのコード構文は以下の通りです: ZCatalystApp.shared.getCurrentUser( completion: @escaping (Result&lt; ZCatalystUser,ZCatalystError &gt; ) -> Void ) **パラメータ**: * **completion**: 呼び出しが成功した場合、completionブロックは現在のユーザーオブジェクトを返します。それ以外の場合は、エラーを返します。 サンプルコードスニペットは以下の通りです: ZCatalystApp.shared.getCurrentUser { ( result ) in switch result{ case .success ( let user) : print("The current user is \(user.firstName).") case .error( let error ) : print( "Error occurred &gt;&gt;&gt; \( error )" ) } } -------------------------------------------------------------------------------- title: "サードパーティ認証" description: "iOSアプリに任意のサードパーティ認証サービスを実装できます。" last_updated: "2026-06-10T06:04:54.165Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/cloud-scale/authentication/third-party-authentication/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Third-Party Authentication (/ja/cloud-scale/help/authentication/third-party-authentication/introduction/) - Generate Custom Server Token- Java SDK (/ja/sdk/java/v1/cloud-scale/authentication/third-party-server-token/) - Generate Custom Server Token- Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/authentication/third-party-server-token/) - Generate Custom Server Token- Python SDK (/ja/sdk/python/v1/cloud-scale/authentication/third-party-server-token/) - Authentication - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) -------------------------------------------------------------------------------- # サードパーティ認証 Cloud ScaleのAuthenticationでは、Catalystアプリケーションに任意のサードパーティ認証サービスを実装できます。エンドユーザーの認可と検証はサードパーティサービスによって処理され、データはCatalystに渡されます。 Note: サードパーティ認証サービスを実装するため、アプリケーションのセキュリティインフラストラクチャは、選択したサードパーティサービスの効率性に依存することをご理解ください。 iOSアプリにサードパーティ認証を実装するには、以下に説明する手順を実行する必要があります。 ### 1. サードパーティ認証サービスの設定 Catalystアプリケーションにサードパーティ認証を関連付ける前に、まず外部サービスでサードパーティのロジック処理を完了させる必要があります。任意のサードパーティで認証を設定できます。 <br> ### 2. Catalystでサードパーティ認証タイプを設定する 設定したサードパーティ認証をCatalystに設定する必要があります。CatalystコンソールのCloud Scale内のAuthenticationコンポーネントに移動します。手順はCatalystでのサードパーティ認証の設定ヘルプページで説明されています。 このプロセスには、実行する必要のある以下の手順が含まれます: **i. カスタムサーバートークンの生成:** ユーザーが認証された後にサードパーティサービスからリダイレクトされると、そのクレデンシャルをJava、Node.js、またはPythonでコーディングする認証関数に渡す必要があります。この関数はCatalystサーバーサイドトークン**jwtToken**または**customToken**を生成し、クライアントサイド（iOSアプリ）に渡されます。CatalystコンソールはcustomTokenを生成するためのすぐに使えるスクリプトを提供しています。このスクリプトをサーバーサイド関数に組み込んで、customTokenを返すことができます。 Note: Catalystアプリケーションでサードパーティ認証を有効にするには、コンソールでPublic Signupを有効にしていることを確認してください。 **ii. クライアントサイドの設定をスキップする:** 最後にクライアントロジックにカスタムサーバートークンを組み込んでログインプロセスを完了するため、コンソールでのクライアントサイド設定は今のところスキップできます。 **iii. 追加設定を構成してセットアップを完了する:** ホワイトリストの一部としてCustomer User ValidationまたはAuthorized Domainsを設定し、セットアップを完了します。 Catalystは、サードパーティ認証サービスが有効になり、アプリケーションの認証がそのサービスによって処理されていることを確認するメッセージを表示します。 <br> ### 3. iOSプロジェクトに設定ファイルを再インポートする CatalystコンソールからiOSアプリのサードパーティ認証を有効にした後、アプリの環境に基づいて、iOSプロジェクトにAppConfigurationDevelopment.plistまたはAppConfigurationProduction.plistプロパティファイルを再度ダウンロードしてインポートする必要があります。これは、このファイルにJWTClientIDとJWTClientSecretの2つの追加プロパティが含まれるようになるためです。これらのプロパティは、SDKを再初期化した後の次のステップで渡す必要があります。 設定ファイルを再ダウンロードするには: 1. プロジェクトのCatalystコンソールで**Settings**に移動し、次に**Developer Tools**に移動します。Mobile SDKセクションの下に既存のiOSパッケージが表示されます。パッケージを開きます。 <br> 2. ポップアップで必要な環境タブをクリックし、**Download**をクリックして設定ファイルをダウンロードします。 <br> こちらに記載されている手順に従って、ダウンロードした設定ファイルを再インポートできます。 Note: SDKセットアップヘルプページに記載されている手順3、4、6を再度実行する必要はありません。 <br> ### 4. SDKを再初期化する 新しくダウンロードしたプロパティをコードに含めるために、SDKを再初期化する必要があります。SDKの再初期化は、初回のSDK初期化と同様に行えます。ただし、新しくダウンロードした設定ファイルから取得したJWTClientIDとJWTClientSecretプロパティをZCatalystAppConfigurationを通じて指定する必要があります。 public func initSDK( window : UIWindow, environment : ZCatalystEnvironment, appConfiguration : ZCatalystAppConfiguration ) throws **パラメータ:** * **window**: ビューにイベントをディスパッチするウィンドウオブジェクト * **appConfiguration**: SDKの機能に必要なすべての設定詳細を含むオブジェクト * **environment**: アプリの環境。**.development**または**.production**のいずれかです。 ここでのenvironmentは、アプリがDevelopmentまたはProduction環境で動作しているかを示します。環境に基づいて適切なplist設定ファイルをアプリのプロジェクトに含めるのと同様に、適切な環境でSDKを再初期化する必要があります。 <br> ### 5. サードパーティ認証のユーザーログインロジックをコーディングする iOSアプリでサードパーティ認証のログインロジックを処理してセットアップを完了できます。[ステップ2](/ja/sdk/ios/v2/cloud-scale/authentication/third-party-authentication/#2-set-up-the-third-party-authentication-type-in-catalyst)で生成されたcustomTokenまたはjwtTokenを、以下に示すようにhandleCustomLogin()メソッドに渡す必要があります: public func handleCustomLogin( withJWT token : String, completion : @escaping ( Error? ) -> Void ) Note: カスタムサーバートークンは、ユーザーがサードパーティ認証サービスを使用してアプリケーションにログインするたびに生成する必要があります。 #### General -------------------------------------------------------------------------------- title: "現在のタイムゾーンの取得" description: "プロジェクトで現在アクティブなタイムゾーンを取得できます。" last_updated: "2026-06-10T06:04:54.173Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/general/get-current-time-zone/" service: "All Services" related: - Time Zone Settings (/ja/getting-started/set-up-a-catalyst-project/general-settings/#change-the-time-zone-of-the-project) -------------------------------------------------------------------------------- # 現在のタイムゾーンの取得 コンソールの一般設定から、プロジェクトのタイムゾーンを定義して保存し、アクセスするデータセンターに基づいて設定されたデフォルトのタイムゾーンを上書きできます。設定したタイムゾーンは、プロジェクトのすべてのサービス、コンポーネント、および機能に適用されます。ただし、特定のコンポーネントに対して個別のタイムゾーンを定義することも可能です。 Catalystでは、プロジェクトで現在アクティブなタイムゾーンを取得できます。以下の構文に示すように、getCurrentTimeZone()メソッドを使用して、コンソールでプロジェクトに定義された現在のタイムゾーンを取得できます。 public func getCurrentTimeZone( completion : @escaping ( Result&lt;TimeZone, ZCatalystError&gt; ) ->Void ) #### Serverless ##### ファンクション -------------------------------------------------------------------------------- title: "Functionインスタンスの作成" description: "Catalyst Functionsを使用すると、アプリケーションにカスタム機能を構築したり、タスクを自動化したり、サードパーティサービスと統合したりできます。" last_updated: "2026-06-10T06:04:54.173Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/serverless/functions/create-function-instance/" service: "Serverless" related: - Functions (/ja/serverless/help/functions/introduction) - Function - API (/ja/api/code-reference/serverless/functions/execute-function/#ExecuteFunction) -------------------------------------------------------------------------------- # Functionインスタンスの作成 Catalyst Functionsを使用すると、アプリケーションにカスタム機能を構築したり、タスクを自動化したり、サードパーティサービスと統合したりできます。CatalystコンソールまたはCLIからiOSアプリ用のFunctionを開発できます。 ### Functionインスタンスの作成 **getFunctionInstance()**メソッドを使用して、Catalyst Functionのインスタンスを作成し、このクラスで定義されたメソッドを有効にしてインスタンスオブジェクトにアクセスできます。これにより、不要なサーバー呼び出しを防ぐことができます。 以下のいずれかの方法でFunctionインスタンスを作成できます： #### i. Function IDを渡す方法 Functionの一意のFunction IDを引数としてgetFunctionInstance()メソッドに渡し、インスタンスを作成できます： ZCatalystApp.shared.getFunctionInstance( id : Int64 ) -> ZCatalystFunction **パラメータ**: * **id**: Functionの一意のFunction IDです。 サンプルコードスニペットを以下に示します： let function_instance = ZCatalystApp.shared.getFunctionInstance ( id : 1096000000002053 ) //ここに関数IDを入力してください #### ii. Function名を渡す方法 FunctionのAPI名を引数としてgetFunctionInstance()メソッドに渡し、インスタンスを作成できます： ZCatalystApp.shared.getFunctionInstance( name : String ) -> ZCatalystFunction **パラメータ**: * **name**: Catalystで設定されたFunctionの名前です。 サンプルコードスニペットを以下に示します： let function_instance = ZCatalystApp.shared.getFunctionInstance ( name : "LocalBackup") //ここに関数名を入力してください -------------------------------------------------------------------------------- title: "Functionの実行" description: "Catalyst Functionsを使用すると、アプリケーションにカスタム機能を構築したり、タスクを自動化したり、サードパーティサービスと統合したりできます。" last_updated: "2026-06-10T06:04:54.173Z" source: "https://docs.catalyst.zoho.com/ja/sdk/ios/v2/serverless/functions/execute-function/" service: "Serverless" related: - Functiona (/ja/serverless/help/functions/introduction) - Implementing Functions (/ja/serverless/help/functions/implementation) - Execute Function - API (/ja/api/code-reference/serverless/functions/execute-function/#ExecuteFunction) -------------------------------------------------------------------------------- # Functionの実行 Functionと一緒に渡すHTTPリクエストに基づいて、以下のいずれかの方法でCatalyst Functionを実行できます。実行するFunctionにパラメータをFunction実行メソッドの引数として渡すことができます。このメソッドはHTTPリクエストタイプごとに異なります。 注意: Catalystでは、Basic I/O、Advanced I/O、Cron、Integration、Event、BrowserLogicの6種類のFunctionを作成できます。ただし、Catalyst iOS SDKではBasic I/O Functionのみを実行できます。 以下のすべてのコードセクションで使用されている&lt;FUNCTION_INSTANCE&gt;は、Functionインスタンスページで定義されたインスタンスです。 ### GET Functionの実行 HTTP GETタイプのFunctionを実行するには、**executeGet()**メソッドにパラメータを渡します： &lt;FUNCTION_INSTANCE&gt;.executeGet( parameters params : [ String : Any ]? = nil, completion : @escaping( Result< String, ZCatalystError &gt; ) -&gt; Void ) **パラメータ**: * **params**: Functionに渡すパラメータをHash mapとして指定します。 サンプルコードスニペットを以下に示します： ZCatalystApp.shared.getFunctionInstance(id: 2823000000097020).executeGet() //ここに関数IDを入力してください { result in switch result { case .success(let output) : print("GET function executed successfully - \( output )") case .error(let error) : print("GET function failed to execute - \( error )") } } ### PUT Functionの実行 HTTP PUTタイプのFunctionを実行するには、**executePut()**メソッドにパラメータをHash mapとして渡します。PUTリクエストのペイロードもHash map引数としてこのメソッドに渡すことができます： &lt;FUNCTION_INSTANCE&gt;.executePut( parameters params : [ String : Any ]? = nil, body : [ String : Any ]? = nil, completion : @escaping( Result< String, ZCatalystError > ) -> Void ) **パラメータ**: * **params**: Functionに渡すパラメータをHash mapとして指定します。 * **body**: Hash mapとして渡すデータペイロードです。 サンプルコードスニペットを以下に示します： var params : [ String : Any ] = [:] params[ "ROWID" ] = "2823000000098012" params[ "Category" ] = "Important" ZCatalystApp.shared.getFunctionInstance(id: 2823000000097020).executePut(parameters: params) //ここに関数IDを入力してください { result in switch result { case .success(let output) : print("PUT function executed successfully - \( output )") case .error(let error) : print("PUT function failed to execute - \( error )") } } ### POST Functionの実行 HTTP POSTタイプのFunctionを実行するには、**executePOST()**メソッドにパラメータをHash mapとして渡します。POSTリクエストのペイロードもHash map引数としてこのメソッドに渡すことができます： &lt;FUNCTION_INSTANCE&gt;.executePost( parameters params : [ String : Any ]? = nil, body : [ String : Any ]? = nil, completion : @escaping( Result< String, ZCatalystError > ) -> Void ) **パラメータ**: * **params**: Functionに渡すパラメータをHash mapとして指定します。 * **body**: Hash mapとして渡すデータペイロードです。 サンプルコードスニペットを以下に示します： var params : [ String : Any ] = [:] params[ "Title" ] = "Data Migration Tasks" params[ "Category" ] = "Official" ZCatalystApp.shared.getFunctionInstance(id: 2823000000097020).executePost(parameters: ) //ここに関数IDを入力してください { result in switch result { case .success(let output) : print("POST function executed successfully - \( output )") case .error(let error) : print("POST function failed to execute - \( error )") } } ## Java ### v1 -------------------------------------------------------------------------------- title: "概要" description: "このページでは、Javaプログラミング要素を使用してマイクロサービスやインタラクティブなWebおよびモバイルアプリケーションを作成できるCatalyst Java SDKパッケージの概要を説明します。" last_updated: "2026-06-10T06:04:54.179Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/overview/" service: "All Services" related: - Catalyst Node.js SDK (/ja/sdk/nodejs/v2/overview/) - Catalyst Web SDK (/ja/sdk/web/v4/overview/) - API Code Reference (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) - Catalyst Functions (/ja/serverless/help/functions/introduction) -------------------------------------------------------------------------------- # Java SDK - 概要 Catalyst向けJava SDKは、Javaプログラミング要素を使用してマイクロサービスやインタラクティブなWebおよびモバイルアプリケーションを作成し、それらをCatalystコンポーネントと連携させるための基盤を提供します。SDKはCatalyst APIに簡単にアクセスするために必要な構造を提供します。REST APIのラッパーとして機能し、Catalystサービスを効果的に利用するのに役立ちます。 Catalystは現在、以下のJavaバージョンをサポートしています： * **Java 25** * **Java 21** * **Java 17** * **Java 11** * **Java 8** ### プロジェクトの初期化 Catalystプロジェクトを初期化するには、ビジネスロジックを記述する前に、Javaソースコードの最初のステートメントとして以下のコードスニペットを追加してください。 ZCProject.initProject(); Note: Java SDKでは、この初期化コマンドをインクルードすることは必須ではありません。関数内で自動的に初期化されます。 #### 特定のSDKスコープでCatalystプロジェクトを初期化する Catalystでは、以下のスコープを使用してプロジェクトを初期化できます： * **Admin**: すべてのコンポーネントとそれぞれの機能に無制限にアクセスできます。たとえば、Data Storeに完全にアクセスし、読み取り、書き込み、削除などのすべての操作を実行できます。 * **User**: コンポーネントや特定の機能へのアクセスを制限できます。たとえば、Data Storeに*読み取り*アクセスのみを提供できます。 Note:<br /> * スコープを指定してプロジェクトを初期化することは必須ではありません。デフォルトでは、初期化されたプロジェクトにはAdmin権限が付与されます。 * ビジネスロジックを構築する際には、適切なスコープでCatalyst SDKを初期化してください。スコープに定義した権限がエンドユーザーの操作を制御します。 * スコープは、Data Store、File Store、およびZCQLに関連する操作にのみ適用されます。 * ビジネスロジックの構築方法に応じて、エンドユーザーがAdmin操作またはUser操作を実行できるかどうかを決定できます。これは、エンドユーザーがCatalyst Authenticationでアプリケーションにサインアップする際に割り当てられるロールに基づいて決定されます。ロールの権限は、Data StoreおよびFile storeのScopes & Permissionsセクションで設定できます。 以下のSDKスニペットを使用すると、*Admin*または*User*スコープでプロジェクトを初期化し、Data Storeで**SELECT**クエリを実行できます： * **Adminスコープでのプロジェクト初期化** ZCProject adminProject = ZCProject.initProject("admin", ZCUserScope.ADMIN); ZCQL.getInstance(adminProject).executeQuery("select * from test"); * **Userスコープでのプロジェクト初期化** ZCProject userProject = ZCProject.initProject("user", ZCUserScope.USER); ZCQL.getInstance().executeQuery("select * from test"); ### クラス階層 すべてのCatalystコンポーネントは、メンバーとメソッドでコンポーネントの動作を定義するJavaクラスとしてモデル化されています。 * ZCProjectはSDKパッケージの基本ベースクラスです。Catalystプロジェクトの設定を初期化し、プロジェクトのコンポーネントを関連付けるメソッドを持っています。 * SDKのクラス関係と階層は、Catalystのプロジェクト階層に従います。 * 各クラスには、そのプロパティを取得する関数と、API呼び出しを通じて直接の子エンティティのデータを取得する関数があります。たとえば、Catalyst Data StoreクラスのZCDataStoreには、テーブルにアクセスするメンバー関数があり、テーブル名やIDなどを設定するために直接の子クラスZCTableの関数を使用できます。 Catalystの各コンポーネントのクラス階層は以下のように表されます： ### インスタンスオブジェクト 下位レベルのコンポーネントのデータを取得するために、クラス階層を最上位からすべてたどることは、各レベルでAPI呼び出しが必要になるため、常に効率的ではありません。これを回避するために、すべてのコンポーネントクラスにはダミーオブジェクトを取得するためのgetInstance()メソッドと、子エンティティのダミーオブジェクトを取得するメソッドがあります。 Note: getInstance()メソッドは、API呼び出しが行われないため、プロパティが設定されていない状態で返されます。これはクラスの非静的メソッドにアクセスするためにのみ使用されるダミーオブジェクトを返します。 Catalystコンポーネントのプロパティを取得するには、コンポーネントのオブジェクトをgetInstance()メソッドで呼び出し、その同じオブジェクトを使用してコンポーネントが定義する他のメソッドを呼び出します。これにより、不要なAPI呼び出しを回避できます。 ### 例外処理 予期しない不正な動作は例外と呼ばれます。すべてのエラーと例外は、Java SDKで定義されたZCExceptionというクラスによって処理されます。クライアントコードとサーバーコードによってスローされる特定の例外をキャッチするために、ZCServerExceptionクラスとZCClientExceptionクラスがあります。 -------------------------------------------------------------------------------- title: "Java SDKのアップグレード" description: "このページでは、Java SDKのアップグレード手順を説明します。" last_updated: "2026-06-10T06:04:54.180Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/upgrade-sdk/" service: "All Services" related: - Catalyst Node.js SDK (/ja/sdk/nodejs/v2/upgrade-sdk/) - Catalyst Python SDK (/ja/sdk/python/v1/overview/) - API Code Reference (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) - Catalyst Functions (/ja/serverless/help/functions/introduction) -------------------------------------------------------------------------------- # Java SDKのアップグレード Catalystは、できるだけ簡単にアプリケーションをコーディングできるよう、最新かつ最も関連性の高い安全なSDKパッケージを常に提供することに努めています。 つまり、Catalystは最適なコーディングサポートを提供するために、SDKパッケージを随時アップグレードします。リリースノートセクションからCatalyst SDKの最新動向を追跡し、SDKパッケージを最新バージョンにアップグレードすることを強くお勧めします。*バグ修正*が発生した場合も、**リリースノート**に掲載します。 Note: 非推奨化の理由により即時のアップグレードが必要な場合は、必要なアップグレードを実行するためにメールで適時にお知らせします。一般的に、SDKは常に最新バージョンにアップグレードすることを強くお勧めします。 ### SDKをアップグレードする手順 Java SDKをアップグレードするには、以下の2つの方法があります： * コンソールで提供されている*静的ダウンロードURL*から最新バージョンをインストールする。 * Java開発にMavenを使用している場合、**Maven設定**を更新する。 #### コンソールの静的ダウンロードURLを使用してインストールする 1. Catalystコンソールにアクセスし、アカウントにログインします。 2. いずれかのCatalystプロジェクトを開き、**プロフィールアイコン**をクリックします。 <br /> 3. *Download SDKs*リストの**Javaアイコン**をクリックして、SDKの最新バージョンをダウンロードします。 <br /> 4. ローカルシステムのプロンプトで**保存**をクリックすると、SDKの最新バージョンがZIPファイルとしてローカルシステムに保存されます。 <br /> 最新のSDKをJava関数で使用するには、コンテンツを解凍し、Java関数の**lib**フォルダに貼り付けてください。**lib**フォルダはJava関数のソースディレクトリ内にあります。 Note: * プロジェクト内で作成・初期化したすべてのJava関数のlibフォルダにSDKコンテンツを貼り付ける必要があります。 * Java SDKの最新バージョンはリリースノートで確認できます。 #### MavenによるSDKの更新 Mavenを通じてJava SDKを更新するには、プロジェクトディレクトリにあるpom.xmlファイルに以下の変更を加える必要があります。 &lt;dependency&gt; &lt;groupId&gt;com.zoho.catalyst&lt;/groupId&gt; &lt;artifactId&gt;java-sdk&lt;/artifactId&gt; &lt;version&gt;1.15.0&lt;/version&gt; // ここに必要なバージョンを指定してください &lt;dependency&gt; Java SDKの最新バージョンが利用可能になり、**編集を保存**するとプロジェクト内のJava関数に組み込まれます。 Note: * プロジェクト内のすべてのJava関数のpom.xmlファイルに同じ変更を適用し、プロジェクト全体でSDKの機能を利用できるようにする必要があります。 * Java SDKの最新バージョンはリリースノートで確認できます。 -------------------------------------------------------------------------------- title: "サードパーティアプリへのSDK統合" last_updated: "2026-06-10T06:04:54.180Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/integrate-sdk-in-third-party-apps/" service: "All Services" related: - Catalyst Environments (/ja/deployment-and-billing/environments/introduction/) - Catalyst Cloud Scale Authentication (/ja/cloud-scale/help/authentication/introduction/) - Catalyst Cloud Scale Stratus (/ja/cloud-scale/help/stratus/introduction/) -------------------------------------------------------------------------------- # Catalyst Java SDKのサードパーティアプリケーションへの統合 Catalyst環境外にデプロイされたアプリケーションで、Catalyst Java SDKのメソッドを統合して使用できます。たとえば、Flaskバックエンド（Catalyst外で実行）を使用してVercelにホストされたReactアプリがCatalyst Cloud Scale Stratusにドキュメントをアップロードしたり、Amazon Web Services EC2上で実行されているデータパイプラインがCatalyst Cloud Scale ZCQLクエリを使用してCatalyst Cloud Scale Data Storeに顧客データをプッシュしたりできます。それぞれのJava SDK操作を使用して実行します。 これらは、外部アプリケーションがCatalystプラットフォーム内にデプロイされることなく、Catalystコンポーネントと安全に連携できる一般的なユースケースのほんの一例です。 外部アプリケーションにCatalyst Java SDKを統合するためのコードスニペットを提供しています。ただし、アプリケーションにコードを実装する前に、以下の前提条件を確認してください。 ### SDK統合の前提条件 外部アプリケーションにCatalyst Java SDKを統合するには、以下の情報が必要です： * **Project ID:** Catalystプロジェクトの一意の識別子です。 * **ZAID (Zoho Account ID):** プロジェクトをCatalyst環境（開発または本番）にリンクするためにCatalystが割り当てる一意のポータル識別子です。 * **Environment:** Catalystプロジェクトのターゲット環境（開発または本番）です。 * **OAuth Credentials:** Catalystのセルフクライアントポータルを介して外部アプリケーションを認証・認可し、Catalystコンポーネントにアクセスするために必要です。以下が必要になります： 1. Client ID 2. Client Secret 3. Refresh Token これらの値を取得した後、Java SDKをアプリケーションに統合できます。 <br> ### 統合手順 それでは、これらの各値を取得し、コードスニペットに設定する方法を見ていきましょう。 以下の手順に従ってください： 1. **Catalystコンソールでプロジェクトを作成する：** コンソールでCatalystプロジェクトを新規作成できます。このヘルプページに記載されている手順を使用してください。 2. **Project IDを取得する：** プロジェクトを作成したら、**Project ID**を控えておく必要があります。Project IDはプロジェクト作成時に自動的に生成されるプロジェクトの一意のIDです。 Catalystコンソールの右上隅にある**設定**アイコンをクリックして確認できます。 **設定**画面で、**Project Settings**に移動し、**General**を選択します。以下のスクリーンショットに示すように、このセクションからProject IDを確認して控えることができます。 <br> 3. **ZAIDを取得する：** このセクションで提供されるコードスニペットに、プロジェクトの**ZAID**を含める必要があります。**ZAID**は、プロジェクトを必要なCatalyst環境（開発または本番）にリンクするためにCatalystが割り当てる一意のポータル識別子です。 ZAIDを取得するには、Catalyst CloudScale Authenticationコンポーネントの設定が必須です。ただし、アプリケーションの認証フローに使用するかどうかは任意です。ZAIDを取得するには： i. コンソールでCatalyst CloudScaleサービスに移動し、**Security & Identity**の下で**Authentication**を選択します。 <br> ii. Native Catalyst Authenticationを設定する必要があります。これにより、Catalystが認証プロセス全体を管理し、追加のコーディングやインフラストラクチャ管理が不要になります。 iii. **Set Up**をクリックします。 <br> iv. **Hosted authentication**タイプを選択します。これにより、アプリケーションの専用ページにログイン要素をホストできます。コンソールから認証を設定・デザインでき、Catalystがアプリケーション用にレンダリングし、すべてのバックエンド要件を処理します。 <br> v. Public Signupオプションを有効にして、ログインコンポーネントにサインアップ機能を表示し、新しいユーザーがアプリケーションに登録してアクセスできるようにする必要があります。詳細なセットアップガイドについては、Hosted Authenticationヘルプページを参照してください。 <br> vi. 確認画面で、**Yes, proceed**をクリックします。 <br> vii. 以下にリストされているサポートされているソーシャルログインオプションのいずれかを有効にし、選択したプロバイダーから対応する**ZAID**値を取得できます。 Note: Google、Microsoft、LinkedIn、FacebookなどのソーシャルログインプロバイダーがZAIDの取得に対応しています。ただし、ZohoログインはZAIDの取得には対応していません。特定のソーシャルログインのZAIDを取得する方法を参照してください。 <br> 4. **セルフクライアントアプリケーションを登録する：** アプリケーションのユーザーに代わってCatalystリソースにアクセスするための認証・認可を行うために、**Refresh Token**、**Client ID**、**Client Secret**を取得する必要があります。 上記の必要な項目を取得するには、まずAPIコンソールでアプリケーションをセルフクライアントとして登録する必要があります。 i. APIコンソールにログインし、**Self-client**をクリックします。 <br> ii. アプリケーションがCatalystで実行する必要のある操作に基づいて、セルフクライアントアプリケーションのスコープを設定します。 利用可能なスコープの詳細を参照してください。 iii. 必要なスコープを指定し、適切な説明を追加して、**Create**をクリックします。 <br> iv. グラントトークンが生成されます。これは一度限りのプロセスであり、コンソールから再度取得することはできないため、コピーして安全に保管してください。 グラントトークンの生成の詳細を参照してください。 <br> v. **Client Secret**タブに切り替え、Client IDとClient Secretの詳細を控えます。 <br> vi. このヘルプページのリクエストを使用して、アクセストークンとリフレッシュトークンを生成できます。このページに記載されている手順を使用して、アクセストークンをリフレッシュすることもできます。 上記のすべての値を控えた後、以下に示すようにコードスニペットに設定し、Java SDKをアプリケーションに統合できます。以下のSpringBootコードは、Catalyst CloudScale Stratusからバケットを取得する例で示しています。 <br> ### コードスニペット package com.example.demoapp; import org.springframework.boot.CommandLineRunner; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.stereotype.Component; import java.util.List; import java.util.logging.Logger; import org.json.simple.JSONObject; import com.zc.common.ZCProject; import com.zc.common.ZCProjectConfig; import com.catalyst.config.ZCThreadLocal; import com.zc.api.APIConstants.ZCAuthType; import com.zc.api.APIConstants.ZCUserScope; import com.zc.auth.ZCAuth; import com.zc.component.USER_TYPE; import com.zc.component.object.ZCObject; import com.zc.component.object.ZCRowObject; import com.zc.component.object.ZCTable; @SpringBootApplication public class DemoappApplication { private static final Logger logger = Logger.getLogger(DemoappApplication.class.getName()); public static void main(String[] args) { SpringApplication.run(DemoappApplication.class, args); } @Component public static class DataProcessor implements CommandLineRunner { @Override public void run(String... args) { try { ZCThreadLocal.putValue("user_type", USER_TYPE.ADMIN); JSONObject oAuthParams = new JSONObject(); oAuthParams.put("client_id", CLIENT_ID); //ここにクライアントIDを入力してください oAuthParams.put("client_secret", CLIENT_SECRET); //ここにクライアントシークレットを入力してください oAuthParams.put("refresh_token", REFRESH_TOKEN); //ここにリフレッシュトークンを入力してください oAuthParams.put("grant_type", "refresh_token"); ZCAuth auth = ZCAuth.getInstance(oAuthParams); auth.setScope(ZCUserScope.ADMIN); System.out.println("Auth Object: " + auth); ZCProjectConfig config = ZCProjectConfig.newBuilder() .setProjectId(PROJECT_ID) //ここにプロジェクトIDを入力してください .setProjectKey(ZAID) //ここにZAIDを入力してください .setZcAuth(auth) .setProjectDomain("https://api.catalyst.zoho.com") .setEnvironment("Development") //"Development"または"Production"を設定してください .build(); ZCProject project = ZCProject.initProject(config, ""); ZCStratus stratus = ZCStratus.getInstance(project); List <ZCBucket> buckets = stratus.listBuckets(); } catch (Exception e) { logger.severe("Error during data processing: " + e.getMessage()); } } } } #### Cloud Scale ##### Data Store -------------------------------------------------------------------------------- title: "テーブルメタデータの取得" description: "このページでは、Javaアプリケーションで単一または複数のテーブルのメタデータを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.181Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/data-store/get-table-meta/" service: "Cloud Scale" related: - Get Table Meta - API (/ja/api/code-reference/cloud-scale/data-store/get-table-metadata/#GetTableMetadata) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # テーブルメタデータの取得 単一または複数のテーブルのメタデータはいくつかの方法で取得できます。 ### テーブルIDによる単一テーブルのメタデータ取得 テーブルのメタデータは、以下のようにgetTable()メソッドを使用してテーブルIDを参照することで取得されます。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCObject; import com.zc.component.object.ZCTable; //ベースオブジェクトインスタンスを作成する ZCObject object = ZCObject.getInstance(); //ベースオブジェクトのテーブルIDを参照してテーブルインスタンスを取得する ZCTable tableMeta = object.getTable(1510000000110121L); ### テーブル名による単一テーブルのメタデータ取得 一方で、テーブル名をgetTable()メソッドの引数として渡すことで、テーブルのメタデータ詳細を取得することもできます。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCObject; import com.zc.component.object.ZCTable; //ベースオブジェクトインスタンスを作成する ZCObject object = ZCObject.getInstance(); //ベースオブジェクトのテーブルIDを参照してテーブルインスタンスを取得する ZCTable tableMeta = object.getTable("SampleTable"); ### すべてのテーブルの取得 単一テーブルのメタデータ取得に加えて、getAllTables()メソッドを使用してCatalystプロジェクト内のすべてのテーブルの詳細を取得できます。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCObject; //ベースオブジェクトインスタンスを作成する ZCObject object = ZCObject.getInstance(); //指定されたプロジェクト内のすべてのテーブルを取得する List<ZCTable> tableList =object.getAllTables(); -------------------------------------------------------------------------------- title: "カラムメタデータの取得" description: "このページでは、Javaアプリケーションでデータストアのテーブルから単一または複数のカラムのメタデータを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.181Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/data-store/get-column-meta/" service: "Cloud Scale" related: - Get Column Meta - API (/ja/api/code-reference/cloud-scale/data-store/get-column-metadata/#GetColumnMetadata) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # カラムメタデータの取得 特定のテーブルの単一または複数のカラムのメタデータを取得するメソッドがあります。 ### カラムIDによる単一カラムのメタデータ取得 前述のテーブルのメタデータ取得に続き、getColumn()メソッドを使用してテーブルの特定のカラムのメタデータを取得します。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCColumn; import com.zc.component.object.ZCObject; import com.zc.component.object.ZCTable; //ベースオブジェクトインスタンスを作成する ZCObject object = ZCObject.getInstance(); //ベースオブジェクトのテーブルIDを参照してテーブルインスタンスを取得する ZCTable table = object.getTable(1510000000110121L); //columnIDを使用して特定の列のメタ情報を取得する ZCColumn column = table.getColumn("1510000000110832"); <br> ### カラム名による単一カラムのメタデータ取得 カラムのメタデータを取得する別の方法として、テーブルIDの代わりにテーブル名を参照する方法があります。これも前述のケースと同じレスポンスを返します。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCColumn; import com.zc.component.object.ZCObject; import com.zc.component.object.ZCTable; //ベースオブジェクトインスタンスを作成する ZCObject object = ZCObject.getInstance(); //ベースオブジェクトのテーブルIDを参照してテーブルインスタンスを取得する ZCTable table = object.getTable(1510000000110121L); //列名を使用して特定の列のメタ情報を取得する ZCColumn column = table.getColumn("Name"); <br> ### すべてのカラムの取得 単一カラムのメタデータ取得に加えて、_getAllColumns()_メソッドを使用して特定のテーブルのすべてのカラムのメタデータを取得できます。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCColumn; import com.zc.component.object.ZCObject; import com.zc.component.object.ZCTable; //ベースオブジェクトインスタンスを作成する ZCObject object = ZCObject.getInstance(); //ベースオブジェクトのテーブルIDを参照してテーブルインスタンスを取得する ZCTable table = object.getTable(1510000000110121L); //テーブル内のすべての列を取得する List columns = table.getAllColumns(); -------------------------------------------------------------------------------- title: "テーブルインスタンスの取得" description: "このページでは、JavaアプリケーションでデータストアのテーブルからテーブルIDおよび名前を使用してテーブルインスタンスを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.181Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/data-store/get-table-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # テーブルインスタンスの取得 ### テーブルIDを使用したテーブルインスタンスの取得 テーブルを参照して操作を実行するための最初のステップとして、空の_テーブルインスタンス_を作成します。これは getTableInstance()メソッドを通じて行われ、実際にはサーバーサイドの呼び出しを行いません。値は保持されません。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCObject; import com.zc.component.object.ZCTable; //ベースオブジェクトインスタンスを作成する ZCObject object = ZCObject.getInstance(); //ベースオブジェクトのtableIDを参照してテーブルインスタンスを取得する ZCTable tableMeta =object.getTableInstance(1510000000110121L); <br> ### テーブル名を使用したテーブルインスタンスの取得 ここではテーブルを参照するためにテーブル名を引数として渡します。サーバーサイドの呼び出しは行われず、前述のケースと同等です。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCObject; import com.zc.component.object.ZCTable; //ベースオブジェクトインスタンスを作成する ZCObject object = ZCObject.getInstance(); //ベースオブジェクトのテーブルIDを参照してテーブルインスタンスを取得する ZCTable tableMeta = object.getTableInstance("SampleTable"); -------------------------------------------------------------------------------- title: "行の挿入" description: "このページでは、Javaアプリケーションでデータストアのテーブルに単一行または一括で行を挿入するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.181Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/data-store/insert-rows/" service: "Cloud Scale" related: - Insert Rows - API (/ja/api/code-reference/cloud-scale/data-store/insert-new-row/#InsertNewRow) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の挿入 テーブルの一意のIDまたは名前を参照して、Data Storeのテーブルに新しいデータ行またはレコードを挿入できます。次のセクションで説明するように、テーブルに複数の行を挿入することもできます。 Note: 1. テーブルとそのカラムは事前に作成しておく必要があります。コンソールからテーブルを作成し、カラムを作成できます。 2. 開発環境では、プロジェクトごとに各テーブルに最大5,000レコードを挿入できます。開発環境ではプロジェクト全体で最大25,000レコードを作成できます。本番環境ではレコード作成の上限はありません。 ### 単一行の挿入 以下のサンプルコードに示すように、行インスタンスを作成し、カラム名とそれに対応する値を渡す必要があります。insertRow()メソッドは、一意の名前またはIDで参照して作成したインスタンスのテーブルに行を挿入します。行が挿入されると、その行の一意のRowID値が自動的に生成されます。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCObject; import com.zc.component.object.ZCRowObject; import com.zc.component.object.ZCTable; //ベースオブジェクトインスタンスを作成する ZCObject object = ZCObject.getInstance(); //ベースオブジェクトのtableIDを参照してテーブルインスタンスを取得する ZCTable tab = object.getTable("1510000000110121"); //行インスタンスを作成する ZCRowObject row = ZCRowObject.getInstance(); //行インスタンスのset()メソッドを使用して必要な列の値を設定する row.set("Name","George Smith"); row.set("Age", 25); //insertRow()メソッドを呼び出してテーブルに単一行を追加する tab.insertRow(row); <br> ### 複数行の挿入 以下に示すように、行オブジェクトのリストを構築し、insertRows()メソッドの引数として渡すことで、テーブルに複数の行を挿入できます。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCObject; import com.zc.component.object.ZCRowObject; import com.zc.component.object.ZCTable; //RowObjectsのリストを作成する List rows = new ArrayList(); //ベースオブジェクトインスタンスを作成する ZCObject object = ZCObject.getInstance(); //ベースオブジェクトのtableIDを参照してテーブルインスタンスを取得する ZCTable tab = object.getTable(1510000000110121L); //必要な数の行インスタンスを作成する ZCRowObject row1 = ZCRowObject.getInstance(); ZCRowObject row2 = ZCRowObject.getInstance(); //set()メソッドを使用して各行に列の値を設定する row1.set("Name","George Smith"); row1.set("Age", 25); row2.set("Name","Moana Violet"); row2.set("Age", 22); //add()メソッドを使用してリストに行を追加する rows.add(row1); rows.add(row2); //insertRows()メソッドを使用してテーブルにリストを追加する tab.insertRows(rows); -------------------------------------------------------------------------------- title: "行の取得" description: "このページでは、Javaアプリケーションでデータストアのテーブルから単一行またはすべての行を取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.182Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/data-store/get-rows/" service: "Cloud Scale" related: - Get Rows - API (/ja/api/code-reference/cloud-scale/data-store/get-all-rows/#GetAllRows) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の取得 Catalyst Data Storeのテーブルから単一行または複数行のデータを取得できます。以下のサンプルコードに示すように、テーブルの一意のテーブルIDをgetTable()メソッドに渡すことで行を取得できます。 ### 単一行の取得 getRow()メソッドを使用して、テーブルから単一行のデータを取得できます。以下に示すように、取得したい行の一意のRow IDをこのメソッドに渡す必要があります。 まずgetInstance()を使用してベースオブジェクトインスタンスを取得する必要があります。ベースオブジェクトインスタンスを使用して、行の取得に使用するテーブルインスタンスを取得する必要があります。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCObject; import com.zc.component.object.ZCRowObject; import com.zc.component.object.ZCTable; //ベースオブジェクトインスタンスZCObjectを作成する ZCObject obj = ZCObject.getInstance(); //ベースオブジェクトを使用してテーブルIDを参照してテーブルインスタンスを取得する ZCTable tab = obj.getTable(1510000000110121L); //Row IDを渡してテーブルから単一行を取得する ZCRowObject row = tab.getRow(1510000000108103L); <br> ### ページネーションによるすべての行の取得 ZCRowPagedResponseクラスを使用してコードにページネーションを組み込むことで、Data Storeのテーブルからすべての行を取得できます。ページネーションにより、テーブルの行をバッチまたはページ単位でイテレーションを通じて取得できます。 たとえば、個別のページとして100行ずつバッチで行を取得する場合、各ページで取得する最大行数の変数を定義し、数を指定できます。以下のサンプルコードではmaxRowsを100に設定しています。 Note: maxRowsパラメータはオプションです。この値が指定されていない場合、SDK呼び出しはデフォルトで単一ページに200行を返します。 さらに、ループの各実行後に、後続のデータ取得を認可するトークン文字列がレスポンスに含まれます。getNextToken()メソッドを通じてこのトークンを取得し、以下のコードに示すように、後続のイテレーションでnextTokenの値として渡します。ループの最初の実行時、nextToken文字列の値はnullとして割り当てられます。 このイテレーションは、moreRecordsAvailable()メソッドで検証される、すべての行が取得されるまで実行されます。 サンプルコードに示すように、テーブル名と取得するカラム名を指定できます。 Note: ページネーションはJava SDK v1.7.0アップデートから利用可能になりました。古いバージョンのJava SDKでは利用できません。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCObject; import com.zc.component.object.ZCRowObject; import com.zc.component.object.ZCRowPagedResponse; String nextToken = null; //最初のnextTokenの値をnullとして宣言する iteration ZCRowPagedResponse pagedResp; //ページングされたレスポンスオブジェクトを定義する Long maxRows = 100; //1ページで取得する最大行数を定義する do { pagedResp = ZCObject.getInstance().getTable(empDetails).getPagedRows(nextToken, maxRows); //テーブル名を指定し、nextTokenとmaxRowsを渡してページングされたレスポンスを取得する //列名を渡してテーブルから列を取得する for(ZCRowObject row : pagedResp.getRows()) { basicIO.write("Employee ID: " +row.get("empID") + ","); basicIO.write("Name: " +row.get("empName") + ","); basicIO.write("Department: " +row.get("empDept") + ","); } //反復を検証し、レスポンスで取得したトークン文字列を次の反復に渡す if(pagedResp.moreRecordsAvailable()) { nextToken = pagedResp.getNextToken(); } } while(pagedResp.moreRecordsAvailable()); Note: テーブルから複数行のデータを取得するために以前利用可能であったgetAllRows()メソッドのサポートは廃止されました。ページネーションは、取得する行数の制限なくすべての行を取得できる拡張機能として利用可能です。getAllRows()メソッドは今後のすべてのSDKバージョンから削除されます。コードを適宜アップグレードしてください。 -------------------------------------------------------------------------------- title: "行の更新" description: "このページでは、Javaアプリケーションでデータストアのテーブルの単一行または一括で行を更新するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.182Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/data-store/update-rows/" service: "Cloud Scale" related: - Update Rows - API (/ja/api/code-reference/cloud-scale/data-store/update-row/#UpdateRow) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の更新 テーブル内の単一行または複数行の1つ以上のカラム値を更新する場合、 updateRows()メソッドを使用します。 Note: 行を更新するにはROWIDを設定する必要があります。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCObject; import com.zc.component.object.ZCRowObject; import com.zc.component.object.ZCTable; //ベースオブジェクトインスタンスを作成する ZCObject object = ZCObject.getInstance(); //ベースオブジェクトのテーブルIDを参照してテーブルインスタンスを取得する ZCTable table = object.getTable(1510000000110121L); // テーブルIDを置き換えてください //RowObjectsのリストを作成する List<ZCRowObject> rows = new ArrayList(); //行インスタンスを作成する ZCRowObject row1 = ZCRowObject.getInstance(); ZCRowObject row2 = ZCRowObject.getInstance(); //ROWIDを参照して行に更新された値を設定する row1.set("Name","Amelia S"); row1.set("Age", 19); row1.set("ROWID", 1510000000109113L); // 行IDを置き換えてください row2.set("Name", "Walker Don"); row2.set("Age", 19); row2.set("ROWID", 1510000000109115L); // 行IDを置き換えてください //リストに行を追加する rows.add(row1); rows.add(row2); //テーブル内の複数行を更新する table.updateRows(rows); -------------------------------------------------------------------------------- title: "行の削除" description: "このページでは、Javaアプリケーションでデータストアのテーブルから単一行を削除するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.182Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/data-store/delete-row/" service: "Cloud Scale" related: - Delete Data - API (/ja/api/code-reference/cloud-scale/data-store/delete-row/#DeleteRow) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の削除 テーブルから行を削除するには、呼び出しメソッドdeteleRow()にROWIDを渡すだけです。一度に複数の行を削除することはできません。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCObject; import com.zc.component.object.ZCTable; //ベースオブジェクトインスタンスを作成する ZCObject obj = ZCObject.getInstance(); //ベースオブジェクトのテーブルIDを参照してテーブルインスタンスを取得する ZCTable tab = obj.getTable(1510000000110121L); //ROWIDで単一行を削除する tab.deleteRow(1510000000109115L); -------------------------------------------------------------------------------- title: "一括行読み取り" description: "このページでは、Javaアプリケーションでデータストアのテーブルから複数の行を読み取るメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.182Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/data-store/bulk-read/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 一括行読み取り Catalystでは、Data Storeの特定のテーブルに対して一括読み取りジョブを実行できます。 以下のSDKスニペットでは、一括読み取りジョブが特定のテーブルから数千のレコードを読み取り、ジョブが成功した場合、読み取り操作の結果を含むCSVファイルを生成できます。テーブルは一意のテーブルIDで参照されます。 CatalystはJava SDKの一括書き込みに対して以下のメソッドをサポートしています： <table class="content-table"> <thead> <tr> <th>使用メソッド</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>createBulkReadJob()</td> <td>新しい一括読み取りジョブを作成します。</td> </tr> <td>getBulkReadJobStatus()</td> <td>一括読み取りジョブのステータスと結果を確認します。</td> </tr> </tbody> </table> 以下のSDKスニペットをコピーして、特定のテーブルに対して一括読み取りジョブを実行します。 #### サンプルコードスニペット <br> import com.zc.component.object.bulk.ZCBulkReadServices; import com.zc.component.object.bulk.ZCBulkQueryDetails; import com.zc.component.object.bulk.ZCBulkCallbackDetails; import com.zc.component.object.bulk.ZCDataStoreBulk; import com.zc.component.object.bulk.result.ZCBulkResult; import com.zc.component.object.bulk.ZCBulkReadDetails; ZCBulkReadServices bulkRead = ZCDataStoreBulk.getInstance().getBulkReadInstance(); bulkRead.createBulkReadJob(12096000000642178L); //ここにテーブルIDを入力してください // テーブルIDで一括読み取りジョブを作成する ZCBulkQueryDetails bulkQueryDetails = ZCBulkQueryDetails.getInstance(); // 一括クエリ詳細インスタンスを取得する ZCBulkCallbackDetails callbackDetails = ZCBulkCallbackDetails.getInstance(); // 一括コールバック詳細インスタンスを取得する bulkRead.createBulkReadJob(12096000000642178L, bulkQueryDetails); //ここにテーブルIDを入力してください // テーブルIDで一括読み取りジョブを作成する and query details bulkRead.createBulkReadJob(12096000000642178L, bulkQueryDetails, callbackDetails); //ここにテーブルIDを入力してください // テーブルIDで一括読み取りジョブを作成する ZCBulkReadDetails bulkReadDetails = ZCBulkReadDetails.getInstance(); // 一括読み取り詳細インスタンスを作成する bulkReadDetails.setTableIdentifier(12096000000642178L); // Table IDを入力してください ZCBulkResult readJob = bulkRead.createBulkReadJob(bulkReadDetails); // 一括読み取り詳細で一括読み取りジョブを作成する。 bulkRead.getBulkReadJobStatus(readJob.getJobId()); // 一括読み取りジョブのステータスと結果を取得する <br /> Note: createBulkReadJob()メソッドを使用して同時に読み取れる行は最大200,000行です。 <br /> -------------------------------------------------------------------------------- title: "一括行書き込み" description: "このページでは、Javaアプリケーションでデータストアのテーブルに複数の行を書き込むメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.182Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/data-store/bulk-write/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 一括行書き込み Catalystでは、Data Storeの特定のテーブルに対して一括書き込みジョブを実行できます。一括書き込み操作は、StratusにアップロードされたCSVファイルから数千のレコードを取得し、特定のテーブルに挿入できます。 テーブルは一意のテーブルIDで参照されます。書き込み操作を実行するカラムは、一意のカラムIDで参照されます。 Note: 一括書き込み操作を実行するには、必要なデータをCSVファイルとしてStratusに最初にアップロードする必要があります。 書き込みジョブ中、ファイルは以下の属性を使用して参照されます： * bucketName: オブジェクトが保存されているバケットの名前です。 * objectKey: 必要なオブジェクトのパスまたはObject URLを含めることができます。 * versionID: バケットでバージョニングが有効な場合、ファイルの特定のversionIDがこの属性に保存されます。 これらの詳細はobjectDetailsという名前のJSONオブジェクトとして解決し、setObjectDetails()メソッドに渡す必要があります。 CatalystはJava SDKの一括書き込みに対して以下のメソッドをサポートしています： <table class="content-table"> <thead> <tr> <th>使用メソッド</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>createBulkWriteJob(bulkWriteDetails)</td> <td>特定のテーブルに対して新しい一括書き込みジョブを作成します。</td> </tr> <td>createInsertBulkWriteJob(table ID, objectDetails)</td> <td>新しい一括書き込み挿入ジョブを作成します。</td> <tr> <td>createUpsertBulkWriteJob(tableId, objectDetails, column ID)</td> <td>新しい一括書き込みupsertジョブを作成します。</td> </tr> <tr> <td>getBulkWriteJobDetails(jobID)</td> <td>一括書き込みジョブのステータスと結果を取得します。</td> </tr> </tbody> </table> 以下のSDKスニペットをコピーして、特定のテーブルに対して一括書き込みジョブを実行します。 #### サンプルコードスニペット <br> import com.zc.component.object.bulk.ZCBulkWriteServices; import com.zc.component.object.bulk.ZCDataStoreBulk; import com.zc.component.object.bulk.result.ZCBulkResult; import com.zc.component.object.bulk.ZCBucketObjectDetails; import com.zc.component.object.bulk.ZCBulkWriteDetails ZCBulkWriteServices bulkWrite = ZCDataStoreBulk.getInstance().getBulkWriteInstance(); // 一括書き込みインスタンスを作成する ZCBulkWriteDetails bulkWriteDetails = ZCBulkWriteDetails.getInstance(); // 一括書き込み詳細オブジェクトを作成して入力する bulkWriteDetails.setTableIdentifier(12096000000642178L); // Table IDを入力してください bulkWriteDetails.setObjectDetails(objectDetails); ZCBulkResult bulkWriteResult = bulkWrite.createBulkWriteJob(bulkWriteDetails); // 一括書き込みジョブを作成する bulkWrite.createInsertBulkWriteJob(12096000000642178L, objectDetails); // Table IDを入力してください // 一括書き込み挿入ジョブを作成する bulkWrite.createUpdateBulkWriteJob(12096000000642178L, objectDetails, 12096000000642900L); // Table IDとColumn IDを入力してください // 一括書き込み更新ジョブを作成する bulkWrite.createUpsertBulkWriteJob(12096000000642178L, objectDetails, 12096000000642900L); // Table IDとColumn IDを入力してください // 一括書き込みupsertジョブを作成する bulkWrite.getBulkWriteJobStatus(bulkWriteResult.getJobId()); // 一括書き込みジョブのステータスと結果を取得する <br /> Note: createBulkWriteJob()メソッドを使用して同時に書き込める行は最大100,000行です。 <br /> -------------------------------------------------------------------------------- title: "行の一括削除" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してData Storeのテーブルから行を一括削除する方法について説明します。" last_updated: "2026-06-10T06:04:54.182Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/data-store/bulk-delete-rows/" service: "Cloud Scale" related: - Bulk Delete Rows - API (/ja/api/code-reference/cloud-scale/data-store/bulk-delete-rows/#BulkDeleteRows) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の一括削除 Catalystでは、Data Storeの特定のテーブルからレコードまたはデータ行を一括で削除できます。テーブルは一意のIDまたは名前で参照されます。テーブルIDはData Storeから、またはコンソールでテーブルを開いたときのURLから取得できます。 一括削除操作では、1回の操作で最大200行を削除できます。以下のサンプルコードに示すように、削除する行の一意のROWIDをArrayListに追加できます。コードには少なくとも1つのROWIDを含める必要があり、最大200個のROWIDを含めることができます。 ArrayListはZCRowObjectリストを通じてdeleteRows()関数に渡されます。テーブル名またはテーブルIDはgetTableInstance()に渡す必要があります。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCObject; import com.zc.component.object.ZCRowObject; //ArrayListを定義して、削除するレコードのROWIDを追加する ArrayList rowIdList = new ArrayList<>(); rowIdList.add(1028000000171815L); // 行IDを置き換えてください rowIdList.add(1028000000171810L); rowIdList.add(1028000000171805L); rowIdList.add(1028000000171617L); rowIdList.add(1028000000171098L); //ArrayListをdeleteRows()関数に渡す。 //テーブルIDまたはテーブル名をZCObjectとして渡す。 List &lt;ZCRowObject&gt; deletedRowList = ZCObject.getInstance().getTableInstance("EmpDetails").deleteRows(rowIdList); ##### File Store -------------------------------------------------------------------------------- title: "フォルダインスタンスの作成" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してFile Storeからフォルダインスタンスを取得する方法について説明します。" last_updated: "2026-06-10T06:04:54.183Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/file-store/create-folder-instance/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction) -------------------------------------------------------------------------------- # File Store 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 Catalyst File Storeは、Catalystアプリケーションのアプリケーションファイルとユーザーデータファイルのクラウドストレージソリューションを提供し、共有データへのアクセスを可能にします。画像、動画、テキストファイル、ドキュメントファイル、スプレッドシート、またはその他の形式のファイルを保存、管理、整理できます。 ## フォルダインスタンスの作成 空のフォルダインスタンスを作成し、File Store内の特定のフォルダを参照してファイル操作を実行できます。これは、getInstance()メソッドでFile Storeインスタンスを取得し、それを使用してgetFolderInstance()メソッドでフォルダインスタンスを取得することで行います。 以下に示すように、フォルダインスタンスを作成する特定のフォルダを、一意のIDまたは名前で参照できます。 #### サンプルコードスニペット <br> import com.zc.component.files.ZCFile; import com.zc.component.files.ZCFolder; ### フォルダIDを使用したフォルダインスタンスの取得 //ファイルストアのインスタンスを取得する ZCFile fileStore = ZCFile.getInstance(); //File StoreインスタンスでIDを参照して特定のフォルダのフォルダインスタンスを取得する ZCFolder folderDetails = fileStore.getFolderInstance(1510000000109393L); ### フォルダ名を使用したフォルダインスタンスの取得 //ファイルストアのインスタンスを取得する ZCFile fileStore = ZCFile.getInstance(); //File Storeインスタンスで名前を参照して特定のフォルダのフォルダインスタンスを取得する ZCFolder folderDetails = fileStore.getFolderInstance("EmpDetails"); -------------------------------------------------------------------------------- title: "フォルダ詳細の取得" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してFile Storeからフォルダの詳細を取得する方法について説明します。" last_updated: "2026-06-10T06:04:54.183Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/file-store/get-folder-details/" service: "Cloud Scale" related: - Retrieve the Folder Details - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder) - File Store (/ja/cloud-scale/help/file-store/introduction) -------------------------------------------------------------------------------- # フォルダ詳細の取得 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 Catalyst File Storeに作成されたフォルダのメタデータを取得できます。プロジェクトのFile Store内の特定のフォルダの詳細、またはプロジェクト内のすべてのフォルダの詳細を取得できます。 ### 特定のフォルダの詳細を取得 こちらで説明されているように、フォルダインスタンスを作成することで特定のフォルダの詳細を取得できます。まずFile Storeインスタンスを取得し、それを使用してフォルダインスタンスを取得する必要があります。 #### サンプルコードスニペット <br> import com.zc.component.files.ZCFile; import com.zc.component.files.ZCFolder; メタデータを取得する特定のフォルダを、2つの方法で参照できます: #### フォルダIDによるフォルダの参照 以下に示すように、取得するフォルダの一意のフォルダIDをgetFolder()メソッドに指定できます。 //Get an instance of the File Store ZCFile fileStore = ZCFile.getInstance(); //フォルダIDを渡してフォルダの詳細を取得する ZCFolder folderDetails = fileStore.getFolder(1510000000109393L); #### フォルダ名によるフォルダの参照 以下に示すように、取得するフォルダの名前をgetFolder()メソッドに指定できます。 //Get an instance of the File Store ZCFile fileStore = ZCFile.getInstance(); //フォルダ名を渡してフォルダの詳細を取得する ZCFolder folderDetails = fileStore.getFolder("EmpDetails"); <br> ### すべてのフォルダの詳細を取得 Catalystプロジェクト内のすべてのフォルダの詳細を取得する場合は、以下のgetFolder()メソッドのバリエーションを使用します: #### サンプルコードスニペット <br> import com.zc.component.files.ZCFile; import com.zc.component.files.ZCFolder; //Get an instance for the file store ZCFile fileStore = ZCFile.getInstance(); //プロジェクト内のすべてのフォルダを取得する List&lt;ZCFolder&gt;folderDetails = fileStore.getFolder(); -------------------------------------------------------------------------------- title: "ファイルのアップロード" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してFile Storeのフォルダにファイルをアップロードする方法について説明します。" last_updated: "2026-06-10T06:04:54.183Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/file-store/upload-file/" service: "Cloud Scale" related: - Upload a File - API (/ja/api/code-reference/cloud-scale/file-store/upload-file-in-folder/#UploadFileInaFolder) - File Store (/ja/cloud-scale/help/file-store/introduction) -------------------------------------------------------------------------------- # フォルダへのファイルのアップロード 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 ローカルシステムからFile Storeの既存フォルダに、フォルダの一意のIDを参照してファイルをアップロードできます。画像、テキストドキュメント、CSV、またはその他の必要な種類のファイルをアップロードできます。アップロードできるファイルの最大サイズは100 MBです。 以下に示すように、アップロードするファイルのファイルオブジェクトを作成し、File Storeインスタンスを作成する必要があります。次に、getFolderInstance()にフォルダIDを渡してフォルダの詳細を取得し、uploadFile()メソッドを使用してファイルオブジェクトをフォルダインスタンスにアップロードします。 ファイルのアップロード後、そのファイルに一意のファイルIDが作成されます。 注意: Catalystでは、開発環境の各プロジェクトに1 GBのFile Storeスペースが提供されます。本番環境ではストレージに上限はありません。 #### サンプルコードスニペット <br> import com.zc.component.files.ZCFile; import com.zc.component.files.ZCFolder; import java.io.File; // ファイルオブジェクトを作成 File f = new File("empdetails.csv"); //File Storeのインスタンスを作成する ZCFile fileStore = ZCFile.getInstance(); //フォルダIDを使用してフォルダインスタンスを取得する ZCFolder folder = fileStore.getFolderInstance(1510000000109393); //フォルダインスタンスを使用してファイルをアップロードする folder.uploadFile(f); -------------------------------------------------------------------------------- title: "フォルダからファイルをダウンロード" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してFile Storeのフォルダからファイルをダウンロードする方法について説明します。" last_updated: "2026-06-10T06:04:54.183Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/file-store/download-file-from-folder/" service: "Cloud Scale" related: - Download a File from the folder - API (/ja/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder) - File Store (/ja/cloud-scale/help/file-store/introduction) -------------------------------------------------------------------------------- # フォルダからファイルをダウンロード 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 一意のファイルIDを参照して、フォルダからファイルをダウンロードできます。downloadFile()メソッドを呼び出すことで、ファイルの入力ストリームが取得されます。 #### サンプルコードスニペット <br> import com.zc.component.files.ZCFile; import com.zc.component.files.ZCFolder; //Get an instance for the file store ZCFile fileStore = ZCFile.getInstance(); //フォルダIDを使用してフォルダの詳細を取得する ZCFolder folder = fileStore.getFolderInstance(1510000000109393L); //ファイルIDを使用してファイルをInput Streamとしてダウンロードする InputStream is = folder.downloadFile(1510000000108418L); -------------------------------------------------------------------------------- title: "ファイルの削除" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してFile Storeからフォルダを削除する方法について説明します。" last_updated: "2026-06-10T06:04:54.183Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/file-store/delete-file/" service: "Cloud Scale" related: - Delete a File - API (/ja/api/code-reference/cloud-scale/file-store/delete-file/#DeleteFile) - File Store (/ja/cloud-scale/help/file-store/introduction) -------------------------------------------------------------------------------- # ファイルの削除 注意: Catalystでは、早期アクセスモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 以下のコードスニペットを使用して、フォルダからファイルを削除できます。 注意: 一度削除されたファイルは復元できません。 #### サンプルコードスニペット <br> import com.zc.component.files.ZCFile; import com.zc.component.files.ZCFolder; //Get a file store instance ZCFile fileStore = ZCFile.getInstance(); //フォルダインスタンスを取得する ZCFolder folder = fileStore.getFolderInstance(704000000116007l); //IDを参照してファイルを削除する folder.deleteFile(704000000122001l); ##### NoSQL -------------------------------------------------------------------------------- title: "テーブルメタデータの取得" description: "Catalyst NoSQLは、非リレーショナル、非SQLのデータストレージ手段を提供する完全マネージドの強力なデータベースです。このページでは、NoSQLテーブルのメタデータを取得するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.183Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/nosql/get-table-metadata/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/insert-item/#InsertNewItem) - NoSQL Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/nosql/get-component-instance/) - NoSQL Python SDK (/ja/sdk/python/v1/cloud-scale/nosql/get-component-instance/) -------------------------------------------------------------------------------- # NoSQL Catalyst NoSQLは、アプリケーションの半構造化データ、非構造化データ、および異種データを保存できる完全マネージドの非リレーショナルNoSQLデータストレージ機能です。Catalystは、キーバリューペアベースのJSON形式でドキュメント型のデータストレージをサポートしています。 Catalyst NoSQL Java SDKパッケージを使用すると、プロジェクト内のNoSQLテーブルでCRUDデータ操作を実行できます。NoSQLテーブルのメタデータを取得し、さまざまなサポートされるデータ型のNoSQLアイテムを作成し、特定のテーブルでアイテムの挿入、更新、取得、または削除が行えます。また、クエリ条件を指定してテーブルまたはテーブルのインデックスをクエリすることもできます。 ## テーブルメタデータの取得 Catalystでは、getInstance()メソッドを使用してJava SDKのインスタンスを取得し、NoSQLテーブルのメタデータを取得できます。プロジェクト内の単一テーブルまたはすべてのテーブルのメタデータを取得できます。 ### 単一テーブルのメタデータを取得 Catalyst NoSQLの単一テーブルのメタデータは、このページで説明する2つの方法で取得できます。レスポンスには、パーティションキーとソートキー、TTL属性などのテーブル構成の詳細が含まれます。 #### テーブルIDによるテーブルメタデータの取得 以下に示すように、getTable()メソッドを使用して、プロジェクト内のNoSQLテーブルの一意のテーブルIDを参照してメタデータを取得できます。 //public ZCNoSQLTable getTable(String tableName) throws Exception; //public ZCNoSQLTable getTable(Long tableId) throws Exception; // テーブルIDを使用してテーブルメタデータを取得する ZCNoSQL.getInstance().getTable(2144568989001); <br> #### テーブル名によるテーブルメタデータの取得 以下に示すように、getTable()メソッドを使用して、テーブル名を参照してプロジェクト内のNoSQLテーブルのメタデータを取得できます。 //public ZCNoSQLTable getTable(String tableName) throws Exception; //public ZCNoSQLTable getTable(Long tableId) throws Exception; // テーブル名を使用してテーブルメタデータを取得する ZCNoSQL.getInstance().getTable('Employees'); 注意: テーブル名を変更した場合、コード内の変更を更新する必要があります。 <br> ### すべてのテーブルのメタデータを取得 以下に示すように、getAllTables()メソッドを使用して、プロジェクト内のすべてのテーブルのメタデータを取得できます。 //public List&lt;ZCNoSQLTable&gt; getAllTables() throws Exception; ZCNoSQL.getInstance().getAllTables(); -------------------------------------------------------------------------------- title: "テーブルインスタンスの作成" description: "Catalyst NoSQLは、非リレーショナル、非SQLのデータストレージ手段を提供する完全マネージドの強力なデータベースです。このページでは、NoSQLテーブルのインスタンスを作成するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.184Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/nosql/create-table-instance/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Create and Manage Tables (/ja/cloud-scale/help/nosql/create-manage-tables/) -------------------------------------------------------------------------------- # テーブルインスタンスの作成 Catalyst NoSQLでは、NoSQLテーブルの空のテーブルインスタンスを取得できます。このインスタンスを使用してそのテーブルを参照し、サポートされているすべてのテーブル操作を実行できます。このプロセスはサーバー側の呼び出しを発生させません。 このセクションで説明する2つの方法で、NoSQLテーブルのインスタンスを取得できます。 ### テーブルIDによるインスタンスの取得 以下に示すように、テーブルの一意のIDをgetTableInstance()に渡してテーブルインスタンスを取得します。 //public ZCNoSQLTable getTableInstance(Long tableId); //public ZCNoSQLTable getTableInstance(String tableName); // テーブルIDでテーブルインスタンスを作成する ZCNoSQL.getInstance().getTableInstance(37898901211); <br> ### テーブル名によるインスタンスの取得 以下に示すように、テーブル名をgetTableInstance()に渡してテーブルインスタンスを取得します。 //public ZCNoSQLTable getTableInstance(Long tableId); //public ZCNoSQLTable getTableInstance(String tableName); // テーブルIDでテーブルインスタンスを作成する ZCNoSQL.getInstance().getTableInstance('Employees'); -------------------------------------------------------------------------------- title: "NoSQLアイテムの構築" description: "Catalyst NoSQLは、非リレーショナル、非SQLのデータストレージ手段を提供する完全マネージドの強力なデータベースです。このページでは、NoSQLアイテムを構築するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.185Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/nosql/construct-item/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Working with Data (/ja/cloud-scale/help/nosql/working-with-data/introduction/) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/insert-item/#InsertNewItem) -------------------------------------------------------------------------------- # NoSQLアイテムの構築 Catalyst NoSQLのアイテムは、レコードのような単一のデータポイントのデータを保持する属性のコレクションを表します。プロジェクト内の既存のNoSQLテーブルにカスタムJSON形式でアイテムを挿入または更新できます。ただし、Catalystでアイテムを挿入または更新する前に、アイテムを構築する必要があります。 以下のセクションで説明するように、Catalystがサポートする異なるデータ型の属性を含むNoSQLアイテムを構築できます。CatalystはString、Number、Set of Strings、Set of Numbers、List、Mapなど、いくつかのデータ型をサポートしています。詳細については、共有リソースのサポートされるデータ型の完全なリストを参照してください。 テーブルに対して構成したパーティションキー属性の値を、すべてのデータアイテムで必ず提供する必要があります。テーブルキー、TTL属性、およびその他の詳細については、テーブルキーのヘルプセクションを参照してください。 <br> ### 新しいNoSQLアイテムの作成 以下に示すように、ZCNoSQLItem()メソッドを使用して新しいNoSQLアイテムを作成できます。 ZCNoSQLItem item = new ZCNoSQLItem(); #### JSONまたはMapからの新しいNoSQLアイテムの作成 以下に示すように、プレーンJSONデータまたはMapを定義した後、そこから新しいNoSQLアイテムを作成できます。 //public static ZCNoSQLItem fromJSON(String json) throws Exception; ZCNoSQLItem.fromJSON(&lt;json string&gt;); <br> ### 異なるデータ型のNoSQLアイテムの構築 以下のコードスニペットは、異なるデータ型の属性を持つアイテムを構築する形式を示しています: //public ZCNoSQLItem withString(String attrName, String val) throws Exception; item.withString("attribute name", "&lt;string value&gt;"); //public ZCNoSQLItem withNumber(String attrName, BigDecimal val) throws Exception; //public ZCNoSQLItem withNumber(String attrName, Number val) throws Exception; item.withNumber("attribute name", "&lt;numeric value&gt;"); //public ZCNoSQLItem withInt(String attrName, int val) throws Exception; item.withInt("attribute name", "&lt;integer value&gt;"); //public ZCNoSQLItem withBigInteger(String attrName, BigInteger val) throws Exception; item.withBigInteger("attribute name", "&lt;BigInt value&gt;"); //public ZCNoSQLItem withShort(String attrName, short val) throws Exception; item.withShort("attribute name", "&lt;Short value&gt;"); //public ZCNoSQLItem withFloat(String attrName, float val) throws Exception; item.withFloat("attribute name", "&lt;Float value&gt;"); //public ZCNoSQLItem withDouble(String attrName, double val) throws Exception; item.withDouble("attribute name", "&lt;Double value&gt;"); //public ZCNoSQLItem withLong(String attrName, long val) throws Exception; item.withLong("attribute name", "&lt;Long value&gt;"); //public ZCNoSQLItem withBinary(String attrName, byte[] val) throws Exception; //public ZCNoSQLItem withBinary(String attrName, ByteBuffer val) throws Exception; item.withBinary("attribute name", "&lt;Byte value&gt;"); //public ZCNoSQLItem withStringSet(String attrName, Set&lt;String&gt; val) throws Exception; //public ZCNoSQLItem withStringSet(String attrName, String... val) throws Exception; item.withStringSet("attribute name", "&lt;StringSet/String variadic param value&gt;"); //public ZCNoSQLItem withBigDecimalSet(String attrName, Set&lt;BigDecimal&gt; val) throws Exception; //public ZCNoSQLItem withBigDecimalSet(String attrName, BigDecimal... vals) throws Exception; item.withBigDecimalSet("attribute name", "&lt;DecimalSet/Decimal Variadic param value&gt;"); //public &lt;T extends Number&gt; ZCNoSQLItem withNumberSet(String attrName, T... vals) throws Exception; //public &lt;T extends Number&gt; ZCNoSQLItem withNumberSet(String attrName, Set&lt;T&gt; vals) throws Exception; item.withNumberSet("attribute name", "&lt;Numeric/Numeric Variadic param value&gt;"); //public ZCNoSQLItem withBinarySet(String attrName, Set&lt;byte[]&gt; val) throws Exception; //public ZCNoSQLItem withBinarySet(String attrName, byte[]... vals) throws Exception; //public ZCNoSQLItem withBinarySet(String attrName, ByteBuffer... vals) throws Exception; item.withBinarySet("attribute name", "&lt;Byte Set value&gt;"); //public ZCNoSQLItem withByteBufferSet(String attrName, Set&lt;ByteBuffer&gt; val) throws Exception; item.withByteBufferSet("attribute name", "&lt;Byte Set value&gt;"); //public ZCNoSQLItem withList(String attrName, List&lt;?&gt; val) throws Exception; //public ZCNoSQLItem withList(String attrName, Object... vals) throws Exception; item.withList("attribute name", "&lt;List/Variadic Param value&gt;"); //public ZCNoSQLItem withMap(String attrName, Map&lt;String, ?&gt; val) throws Exception; item.withMap("attribute name", "&lt;Map value&gt;"); //public ZCNoSQLItem withJSON(String attrName, String json) throws Exception; item.withJSON("attribute name", "&lt;JSON String value&gt;"); //public ZCNoSQLItem withBoolean(String attrName, boolean val) throws Exception; item.withBoolean("attribute name", "&lt;Boolean value&gt;"); //public ZCNoSQLItem withNull(String attrName) throws Exception; item.withNull("attribute name"); //public ZCNoSQLItem with(String attrName, Object val) throws Exception; item.with("attribute name", "&lt;Value&gt;"); -------------------------------------------------------------------------------- title: "NoSQLアイテム操作" description: "Catalyst NoSQLは、非リレーショナル、非SQLのデータストレージ手段を提供する完全マネージドの強力なデータベースです。このページでは、さまざまなNoSQLアイテム操作を実行するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.185Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/nosql/item-operations/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Working with Data (/ja/cloud-scale/help/nosql/working-with-data/introduction/) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/insert-item/#InsertNewItem) -------------------------------------------------------------------------------- # NoSQLアイテム操作 Catalyst NoSQLのアイテムは、レコードのような単一のデータポイントのデータを保持する属性のコレクションを表します。以下は、アイテムで使用してさまざまな操作を実行できるメソッドです。 #### 構築済みアイテムから属性を削除 //public ZCNoSQLItem removeAttribute(String attrName) throws Exception; item.removeAttribute("attribute name"); #### 構築中のアイテムからすべてのキーを取得 //public Iterable&lt;Map.Entry&gt;String, Object&gt;&gt; attributes(); item.attributes(); #### 構築済みアイテムに特定の属性が含まれているか確認 //public boolean hasAttribute(String attrName); item.hasAttribute("attribute name"); #### アイテムをMapとして取得 //public Map<String, Object> asMap(); item.asMap(); //public Map&lt;String, Object&gt; getAllAttributesAsMap(); item.getAllAttributesAsMap(); #### アイテムをJSONとして取得 //public String toJSON() throws Exception; item.toJSON(); #### 構築済みアイテムの属性数を取得 //public int numberOfAttributes(); item.numberOfAttributes(); <br> ### ZCNoSQLAttribute ZCNoSQLAttributeクラスを使用して、操作を実行する属性を示すことができます。Mapのネストされた要素にアクセスするには、ZCNoSQLAttributeを使用する際に属性を','で区切ることができます。リストの特定のインデックスにアクセスするには、"[&lt;index&gt;]"のように表記できます。これは以下の例で示されています。 //public static ZCNoSQLAttribute getInstance(String ...pathElements) throws Exception; //public ZCNoSQLAttribute(List&lt;String&gt; pathElements) throws Exception; ZCNoSQLAttribute.getInstance("", ...); new ZCNoSQLAttribute("", ...) NoSQLでサポートされるデータ型は、ZCNoSQLAttributeで以下のように表記できます: <table class="content-table nosql-components-table"> <thead> <tr> <th class="w10p">サポートされるデータ型</th> <th class="w10p">ZCNoSQLAttributeでの表記</th> </tr> </thead> <tbody> <tr> <td>String</td> <td>ZCNoSQLValue.DataType.S </td> </tr> <tr> <td>Numeric</td> <td>ZCNoSQLValue.DataType.N</td> </tr> <tr> <td>Binary</td> <td>ZCNoSQLValue.DataType.B </td> </tr> <tr> <td>Boolean</td> <td>ZCNoSQLValue.DataType.BOOL</td> </tr> <tr> <td>Set of String</td> <td>ZCNoSQLValue.DataType.SS</td> </tr> <tr> <td>Set of Numbers</td> <td>ZCNoSQLValue.DataType.SN</td> </tr> <tr> <td>Set of Binary</td> <td>ZCNoSQLValue.DataType.SB</td> </tr> <tr> <td>List</td> <td>ZCNoSQLValue.DataType.L</td> </tr> <tr> <td>Map</td> <td>ZCNoSQLValue.DataType.M</td> </tr> <tr> <td>Null</td> <td>ZCNoSQLValue.DataType.NuLL</td> </tr> </tbody> </table> <br> ### ZCNoSQLValue このクラスのオブジェクトは、以下に示すように属性の値とそのデータ型を示すために使用されます。 // public ZCNoSQLValue(DataType dataType, Object value) throws Exception; //public static ZCNoSQLValue getInstance(DataType dataType, Object value) throws Exception; new ZCNoSQLValue(&lt;ZCNoSQLValue.DataType&gt;, &lt;Value&gt;) ZCNoSQLValue.getInstance(&lt;ZCNoSQLValue.DataType&gt;, &lt;Value&gt;) <br> ### ZCNoSQLResponseBean このクラスには、サーバーに対して行われたSDK呼び出しのレスポンスが含まれます。以下のメソッドが含まれています。 * getSize - サーバーから読み取りまたは書き込みされたデータのサイズを返すために使用されます。 //public int getSize(); responseBean.getSize(); * getStartKey - より多くのデータが存在する場合、ページネーション用の次のデータセットの開始キーを返すために使用されます。 //public ZCNoSQLItem getStartKey(); responseBean.getStartKey(); * getResponseDataList - 実際のデータを返します。NOSQL_RETURN_VALUEに基づいて、古いデータまたは新しいデータがgetNew_item()またはgetOld_Item()メソッドで返されます。 //public List&lt;Data&gt; getResponseDataList(); responseBean.getResponseDataList().get(&lt;index&gt;).getNew_item(); responseBean.getResponseDataList().get(&lt;index&gt;).getOld_item(); responseBean.getResponseDataList().get(&lt;index&gt;).setStatus(); -------------------------------------------------------------------------------- title: "テーブルにアイテムを挿入" description: "Catalyst NoSQLは、非リレーショナル、非SQLのデータストレージ手段を提供する完全マネージドの強力なデータベースです。このページでは、NoSQLテーブルにアイテムを挿入するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.186Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/nosql/insert-items/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Working with Data (/ja/cloud-scale/help/nosql/working-with-data/introduction/) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/insert-item/#InsertNewItem) -------------------------------------------------------------------------------- # NoSQLテーブルにアイテムを挿入 Catalystでは、アイテムを構築した後、特定のNoSQLテーブルにアイテムを挿入できます。このセクションで説明するように、アイテムはさまざまな方法で挿入できます。 データの追加と操作、CatalystカスタムJSON形式、およびサポートされるデータ型に関するヘルプセクションを参照して、これらのトピックの詳細を学ぶことができます。 注意: Catalystでは、1回のSDK操作でNoSQLテーブルに最大25個のアイテムを一括で挿入できます。 ### 条件なしでアイテムを挿入 ZCNoSQLTableインスタンス、またはリクエストの各部分を構築するために使用できるZCNoSQLInsertHelperインスタンスを使用して、条件なしでNoSQLテーブルに新しいアイテムを挿入できます。 以下に示すように、ZCNoSQLTableインスタンスでデータを挿入できます。 //public ZCNoSQLResponseBean insert(ZCNoSQLItem item) throws Exception; table.insert(&lt;ZCNoSQLItem&gt;); 以下に示すように、ZCNoSQLInsertHelperインスタンスでデータを挿入できます。 //public ZCNoSQLInsertHelper getInsertHelper(ZCNoSQLItem item) throws Exception; //public ZCNoSQLResponseBean insert() throws Exception; table.getInsertHelper(&lt;ZCNoSQLItem&gt;).insert(); このクラスは、条件付きでテーブルにデータを挿入するために使用できます。ZCNoSQLTableインスタンスから取得できます。 <br> ### 条件付きでアイテムを挿入 定義した特定の条件を使用して、NoSQLテーブルの既存アイテムに属性を挿入できます。このタイプでは、テーブルの既存データが取得され、指定された条件に対して評価されます。評価がtrueの場合にのみアイテムが挿入されます。既存データがない場合、条件は無視されアイテムが挿入されます。 以下のスニペットは、ZCNoSQLConditionを使用した条件付きアイテムの挿入を示しています。 //public ZCNoSQLInsertHelper withCondition(ZCNoSQLCondition condition) throws Exception; table.getInsertHelper(&lt;ZCNoSQLItem&gt;).withCondition(&lt;ZCNoSQLCondition&gt;).insert(); 条件は、コンストラクタまたはgetInstance()メソッドを呼び出して取得できるZCNoSQLConditionインスタンスを使用して渡すことができます。条件は3つの方法で初期化できます。 #### 1. 関数を使用する方法 //public static ZCNoSQLCondition getInstance(NoSQLConditionFunction function) throws Exception; //public ZCNoSQLCondition(NoSQLConditionFunction function) throws Exception; ZCNoSQLCondition.getInstance(&lt;NoSQLCondtitionFunction&gt;); new ZCNoSQLCondition(&lt;NoSQLCondtitionFunction&gt;) 2つの組み込み関数が利用可能です。 i. ZCNoSQLAttributeTypeFunction 指定した属性のデータ型が指定したデータ型と一致するかどうかを確認します。 //public ZCNoSQLAttributeTypeFunction(ZCNoSQLAttribute attribute, ZCNoSQLValue.DataType dataType) throws Exception; //public static ZCNoSQLAttributeTypeFunction getInstance(ZCNoSQLAttribute attribute, ZCNoSQLValue.DataType dataType) throws Exception; ZCNoSQLAttributeTypeFunction.getInstance(&lt;ZCNoSQLAttribute&gt;, &lt;ZCNoSQLValue.DataType&gt;); new ZCNoSQLAttributeTypeFunction(&lt;ZCNoSQLAttribute&gt;, &lt;ZCNoSQLValue.DataType&gt;); ii. ZCNoSQLAttributeExistFunction 取得したアイテムに属性が既に存在するかどうかを評価するために使用されます。 //public ZCNoSQLAttributeExistFunction(ZCNoSQLAttribute attribute); //public static ZCNoSQLAttributeExistFunction getInstance(ZCNoSQLAttribute attribute); ZCNoSQLAttributeExistFunction.getInstance(&lt;ZCNoSQLAttribute&gt;); new ZCNoSQLAttributeExistFunction(&lt;ZCNoSQLAttribute&gt;) <br> #### 2. 演算子、オペランド、値を使用する方法 //public static ZCNoSQLCondition getInstance(ZCNoSQLAttribute attribute, NOSQL_OPERATOR operator, ZCNoSQLValue value) throws Exception; //public ZCNoSQLCondition(ZCNoSQLAttribute attribute, NOSQL_OPERATOR operator, ZCNoSQLValue value) throws Exception; ZCNoSQLCondition.getInstance(&lt;ZCNoSQLAttribute&gt;, &lt;NOSQL_OPERATOR&gt;, &lt;ZCNoSQLValue&gt;); new ZCNoSQLCondition(&lt;ZCNoSQLAttribute&gt;, &lt;NOSQL_OPERATOR&gt;, &lt;ZCNoSQLValue&gt;); #### NOSQL_OPERATOR 許可されるNOSQL_OPERATORの値は、contains、not_contains、begins_with、ends_with、in、not_in、between、not_between、equals、not_equals、greater_than、less_than、greater_equal、less_equalです。 #### 条件のグループを使用する方法 //public static ZCNoSQLCondition getInstance(List&lt;ZCNoSQLCondition&gt; groups, NOSQL_CONDITION_GROUP_OPERATOR groupOperator) throws Exception; //public ZCNoSQLCondition(List&lt;ZCNoSQLCondition&gt; groups, NOSQL_CONDITION_GROUP_OPERATOR groupOperator) throws Exception; ZCNoSQLCondition.getInstance(List&lt;ZCNoSQLCondition&gt;,&lt;NOSQL_CONDITION_GROUP_OPERATOR&gt;) new ZCNoSQLCondition(List&lt;ZCNoSQLCondition&gt;,&lt;NOSQL_CONDITION_GROUP_OPERATOR&gt;) #### NOSQL_CONDITION_GROUP_OPERATOR 許可されるNOSQL_CONDITION_GROUP_OPERATORの値は、AND、ORです。 #### NOSQL_RETURN_VALUE 条件の評価後の戻り値を示します。 //public ZCNoSQLInsertHelper withReturnValue(NOSQL_RETURN_VALUE returnValue) throws Exception table.getInsertHelper(&lt;ZCNoSQLItem&gt;).withReturnValue(&lt;NOSQL_RETURN_VALUE&gt;).insert(); 許可されるNOSQL_RETURN_VALUEの値は、NEW、OLD、NULLです。 #### 条件と戻り値を指定した挿入 table.getInsertHelper(&lt;ZCNoSQLItem&gt;).withCondition(&lt;ZCNoSQLCondition&gt;).withReturnValue(&lt;NOSQL_RETURN_VALUE&gt;).insert(); -------------------------------------------------------------------------------- title: "アイテムの更新" description: "Catalyst NoSQLは、非リレーショナル、非SQLのデータストレージ手段を提供する完全マネージドの強力なデータベースです。このページでは、NoSQLテーブルのアイテムを更新するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.186Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/nosql/update-items/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction/) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/insert-item/#InsertNewItem) -------------------------------------------------------------------------------- # NoSQLテーブルのアイテムを更新 Catalystでは、アイテムを構築した後、特定のNoSQLテーブルのアイテムを更新できます。アイテムはプライマリキーを使用して識別されます。例えば、パーティションキーのみ、またはパーティションキーとソートキーの組み合わせを使用してアイテムを識別できます。その後、適切なHTTPリクエストメソッドで更新操作の種類を定義し、アイテムで更新する属性と値を指定します。 注意: Catalystでは、1回のSDK操作でNoSQLテーブル内の最大25個のアイテムを一括で更新できます。 データを更新する方法は2つあります。ZCNoSQLTableインスタンスを使用して条件なしでデータを更新するか、リクエストの各部分を構築するために使用できるZCNoSQLUpdateHelperインスタンスを使用して更新できます。 以下に示すように、ZCNoSQLTableインスタンスでデータを更新できます。 //public ZCNoSQLResponseBean update(ZCNoSQLItem item, ZCNoSQLUpdateAttributeOperation updateAttributeOperation) throws Exception; table.update(&lt;ZCNoSQLItem&gt;, &lt;ZCNoSQLUpdateAttributeOperation&gt;); ZCNoSQLUpdateHelperで更新する場合 #### ZCNoSQLUpdateHelper //public ZCNoSQLInsertHelper getInsertHelper(ZCNoSQLItem item) throws Exception; //public ZCNoSQLResponseBean insert() throws Exception; table.getUpdateHelper(&lt;ZCNoSQLItem&gt;, &lt;ZCNoSQLUpdateAttributeOperation&gt;).update(); #### ZCNoSQLUpdateAttributeOperation このクラスは、既存の属性を追加/更新するか、既存の属性を削除してアイテムを更新するために使用されます。上記のインスタンスは以下のメソッドを使用して取得できます。 属性の挿入または更新の場合 //ZCNoSQLUpdateAttributeOperation(ZCNoSQLAttribute attribute, ZCNoSQLValue updateValue); //ZCNoSQLUpdateAttributeOperation(ZCNoSQLAttribute attribute, NoSQLUpdateAttributeFunction updateFunction); //public static ZCNoSQLUpdateAttributeOperation getPutAttributeInstance(ZCNoSQLAttribute attribute, ZCNoSQLValue updateValue); // public static ZCNoSQLUpdateAttributeOperation getPutAttributeInstance(ZCNoSQLAttribute attribute, NoSQLUpdateAttributeFunction updateFunction); new ZCNoSQLUpdateAttributeOperation(&lt;ZCNoSQLAttribute&gt;, &lt;ZCNoSQLValue&gt;); new ZCNoSQLUpdateAttributeOperation(&lt;ZCNoSQLAttribute&gt;, &lt;NoSQLUpdateAttributeFunction&gt;); ZCNoSQLUpdateAttributeOperation.getPutAttributeInstance(&lt;ZCNoSQLAttribute&gt;, &lt;ZCNoSQLValue&gt;); ZCNoSQLUpdateAttributeOperation.getPutAttributeInstance(&lt;ZCNoSQLAttribute&gt;, &lt;NoSQLUpdateAttributeFunction&gt;) 属性の削除の場合 //ZCNoSQLUpdateAttributeOperation(ZCNoSQLAttribute attribute); //public static ZCNoSQLUpdateAttributeOperation getDeleteAttributeInstance(ZCNoSQLAttribute attribute); new ZCNoSQLUpdateAttributeOperation(&lt;ZCNoSQLAttribute&gt;); ZCNoSQLUpdateAttributeOperation.getDeleteAttributeInstance(&lt;ZCNoSQLAttribute&gt;); 更新には、値を更新するために使用できる特定のビルトイン関数もあります。これらの関数はNoSQLUpdateAttributeFunction型の下にグループ化でき、ZCNoSQLUpdateAttributeOperationインスタンスの取得時に使用できます。 ### NoSQLUpdateAttributeFunction 4つのビルトイン関数があります。 #### ZCNoSQLIfNotExistFunction この関数は、別の既存の属性の値で属性を更新するために使用されます。属性が存在しない場合、指定された値で更新されます。 //public ZCNoSQLIfNotExistFunction(ZCNoSQLAttribute attribute, ZCNoSQLValue value) //public static ZCNoSQLIfNotExistFunction getInstance(ZCNoSQLAttribute attribute, ZCNoSQLValue value); new ZCNoSQLIfNotExistFunction(&lt;ZCNoSQLAttribute&gt;, &lt;ZCNoSQLValue&gt;) ZCNoSQLIfNotExistFunction.getInstance(&lt;ZCNoSQLAttribute&gt;, &lt;ZCNoSQLValue&gt;) #### ZCNoSQLAppendListFunction この関数は、既存または新しいリスト属性に要素を追加するために使用されます。 //public ZCNoSQLAppendListFunction(ZCNoSQLValue...values); //public static ZCNoSQLAppendListFunction getInstance(ZCNoSQLValue...values); new ZCNoSQLAppendListFunction(&lt;List of ZCNoSQLValue&gt;) ZCNoSQLAppendListFunction.getInstance(&lt;List of ZCNoSQLValue&gt;) #### ZCNoSQLAdditionFunction この関数は、セットに要素を追加するか、既存の属性に数値を加算するために使用されます。操作の種類は対象の属性タイプによって異なります。 //public ZCNoSQLAdditionFunction(ZCNoSQLAttribute attribute, ZCNoSQLValue value); //public static ZCNoSQLAdditionFunction getInstance(ZCNoSQLAttribute attribute, ZCNoSQLValue value); new ZCNoSQLAdditionFunction(&lt;ZCNoSQLAttribute&gt;, &lt;ZCNoSQLValue&gt;) ZCNoSQLAdditionFunction.getInstance(&lt;ZCNoSQLAttribute&gt;, &lt;ZCNoSQLValue&gt;) #### ZCNoSQLReductionFunction この関数は、セットから要素を削除するか、既存の属性から数値を減算するために使用されます。操作の種類は対象の属性タイプによって異なります。 //public ZCNoSQLReductionFunction(ZCNoSQLAttribute attribute, ZCNoSQLValue value) throws Exception; //public static ZCNoSQLReductionFunction getInstance(ZCNoSQLAttribute attribute, ZCNoSQLValue value) throws Exception; new ZCNoSQLReductionFunction(&lt;ZCNoSQLAttribute&gt;, &lt;ZCNoSQLValue&gt;) ZCNoSQLReductionFunction.getInstance(&lt;ZCNoSQLAttribute&gt;, &lt;ZCNoSQLValue&gt;) ZCNoSQLUpdateHelperで利用可能なその他のメソッド #### ZCNoSQLCondition 上記で説明した同じ条件を更新にも再利用できます。 NOSQL_RETURN_VALUE 上記で説明した同じ戻り値を更新にも再利用できます。 条件と戻り値を指定した更新 table.getUpdateHelper(&lt;ZCNoSQLItem&gt;,&lt;ZCNoSQLUpdateAttributeOperation&gt;).withCondition(&lt;ZCNoSQLCondition&gt;).withReturnValue(&lt;NOSQL_RETURN_VALUE&gt;).update(); -------------------------------------------------------------------------------- title: "NoSQLテーブルからアイテムを取得" description: "Catalyst NoSQLは、非リレーショナル、非SQLのデータストレージ手段を提供する完全マネージドの強力なデータベースです。このページでは、NoSQLテーブルからアイテムを取得するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.186Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/nosql/fetch-items/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction/) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/insert-item/#InsertNewItem) -------------------------------------------------------------------------------- # NoSQLテーブルからアイテムを取得 Catalystでは、プライマリキーを使用してアイテムを識別し、NoSQLテーブルからアイテムを取得できます。例えば、パーティションキーのみ、またはパーティションキーとソートキーの組み合わせを使用してアイテムを取得できます。また、必要な属性を指定して、取得する属性をオプションでフィルタリングすることもできます。 注意: Catalystでは、1回のSDK読み取り操作でNoSQLテーブルから最大100個のアイテムを取得できます。 ZCNoSQLTableインスタンスを使用して特定の属性をフィルタリングせずにデータを取得するか、リクエストの各部分を構築するために使用できるZCNoSQLFetchHelperインスタンスを使用して取得できます。 ZCNoSQLTableインスタンスでデータを取得するには、以下を使用します。 //public ZCNoSQLResponseBean fetch(ZCNoSQLItem key) throws Exception; table.fetch(&lt;ZCNoSQLItem&gt;); ZCNoSQLFetchHelperで取得する場合 #### ZCNoSQLFetchHelper このクラスは、テーブルからデータを取得し、特定の属性をフィルタリングするために使用できます。ZCNoSQLTableインスタンスから取得できます。 //public ZCNoSQLFetchHelper getFetchHelper(ZCNoSQLItem key) throws Exception; //public ZCNoSQLResponseBean fetch() throws Exception; table.getFetchHelper(&lt;ZCNoSQLItem&gt;).fetch(); ZCNoSQLFetchHelperで利用可能なその他のメソッド #### 必要な属性 このメソッドを使用して、特定の必要な属性のみをフィルタリングして取得できます。 /public ZCNoSQLFetchHelper withRequiredAttributes(List&lt;ZCNoSQLAttribute&gt; requiredAttributesList) throws Exception; table.getFetchHelper(&lt;ZCNoSQLItem&gt;).withRequiredAttributes(&lt;List of ZCNoSQLAttributes&gt;).fetch(); また、consistencyを使用して、読み取り操作をマスターまたはスレーブクラスターのどちらで実行するかを指定できます。trueに設定すると、マスターからクエリされます。falseの場合、スレーブからクエリされます。 注意: マスター・スレーブレプリケーションでは、マスターにデータベースのすべてのデータが含まれ、スレーブにマスターからのコピーが含まれます。スレーブから読み取り操作を実行すると、全体的なコストを削減できますが、更新されたデータの反映にわずかな遅延が生じるトレードオフがあります。 //public ZCNoSQLFetchHelper withConsistency(boolean consistency) throws Exception; table.getFetchHelper(&lt;ZCNoSQLItem&gt;).withConsistency(true/false).fetch(); 必要な属性とconsistencyを指定した取得 table.getFetchHelper(&lt;ZCNoSQLItem&gt;).withRequiredAttributes(&lt;List of ZCNoSQLAttributes&gt;).withConsistency(true/false).fetch(); -------------------------------------------------------------------------------- title: "NoSQLテーブルのクエリ" description: "Catalyst NoSQLは、非リレーショナル、非SQLのデータストレージ手段を提供する完全マネージドの強力なデータベースです。このページでは、NoSQLテーブルのメタデータを取得するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.186Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/nosql/query-table/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction/) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/insert-item/#InsertNewItem) -------------------------------------------------------------------------------- # NoSQLテーブルのクエリ Catalystでは、テーブルのプライマリキーを使用してアイテムを識別し、NoSQLテーブルをクエリしてデータを取得できます。例えば、パーティションキーのみ、またはパーティションキーとソートキーの組み合わせを使用してアイテムを取得できます。 注意: Catalystでは、1回のSDK操作でNoSQLテーブルからページネーション付きで最大100個のアイテムを一括で取得できます。 属性、必要な値、および使用するサポートされている演算子を指定して、アイテムを識別するキー条件を定義できます。サポートされる演算子のリストおよびCatalystコンソールからのクエリに関するヘルプセクションを参照してください。 ZCNoSQLTableインスタンスでデータをクエリするには、以下のスニペットを使用します。 //public ZCNoSQLResponseBean queryTable(ZCNoSQLPartitionKeyCondition partitionKeyCondition, boolean forwardScan, int limit) throws Exception; table.query(&lt;ZCNoSQLPartitionKeyCondition&gt;, &lt;true/false&gt;, &lt;limit&gt;); ZCNoSQLQueryHelperでクエリする場合 ZCNoSQLQueryHelper このクラスは、テーブルからデータをクエリし、その他の条件、ソート順、制限などを指定するために使用できます。ZCNoSQLTableインスタンスから取得できます。 //public ZCNoSQLQueryHelper getQueryHelper(ZCNoSQLPartitionKeyCondition partitionKeyCondition, boolean forwardScan, int limit) throws Exception; //public ZCNoSQLResponseBean queryTable() throws Exception; table.getQueryHelper(&lt;ZCNoSQLPartitionKeyCondition&gt;, &lt;true/false&gt;, &lt;limit&gt;).queryTable(); ZCNoSQLPartitionKeyCondition パーティションキーの条件を構築するために使用されます。テーブルまたはインデックスからデータをクエリするために必要です。 //public ZCNoSQLPartitionKeyCondition(ZCNoSQLAttribute attribute, ZCNoSQLValue value) throws Exception; //public static ZCNoSQLPartitionKeyCondition getInstance(ZCNoSQLAttribute attribute, ZCNoSQLValue value) throws Exception; new ZCNoSQLPartitionKeyCondition(&lt;ZCNoSQLAttribute&gt;, &lt;ZCNoSQLValue&gt;) ZCNoSQLPartitionKeyCondition.getInstance(&lt;ZCNoSQLAttribute&gt;, &lt;ZCNoSQLValue&gt;) セカンダリキー条件 ソートキーの条件を構築するために使用されます。テーブルのクエリ時にソートキーを使用するか、追加のソートキーを使用するかを示すために使用されます。 //public static ZCNoSQLSecondaryKeyCondition getInstance(ZCNoSQLAttribute attribute, SECONDARY_KEY_CONDITION_OPERATOR operator, ZCNoSQLValue value) throws Exception new ZCNoSQLSecondaryKeyCondition(&lt;ZCNoSQLAttribute&gt;, &lt;SECONDARY_KEY_CONDITION_OPERATOR&gt;, &lt;ZCNoSQLValue&gt;) ZCNoSQLSecondaryKeyCondition.getInstance(&lt;ZCNoSQLAttribute&gt;, &lt;SECONDARY_KEY_CONDITION_OPERATOR&gt;, &lt;ZCNoSQLValue&gt;) //public ZCNoSQLQueryHelper withSecondaryKeyCondition(ZCNoSQLSecondaryKeyCondition secondaryKeyCondition, Boolean isAdditionalSortKey) throws Exception; table.getQueryHelper(&lt;ZCNoSQLPartitionKeyCondition&gt;, &lt;true/false&gt;, &lt;limit&gt;).withSecondaryKeyCondition(&lt;ZCNoSQLSecondaryKeyCondition&gt;, &lt;true/false&gt;).queryTable(); ZCNoSQLQueryHelperで利用可能なその他のメソッド SECONDARY_KEY_CONDITION_OPERATOR 使用できる値は、begins_with、between、equals、greater_than、less_than、greater_equal、less_equalです。 その他の条件 パーティションキーとソートキー（指定した場合）を使用して取得したデータをフィルタリングするために使用できます。これはキーを使用して取得したデータの上にのみ適用されます。そのため、指定したパーティションキー、ソートキー、およびその他の条件のデータが存在しても、最大100アイテムの制限に対して、その他の条件と開始キーを適用した後に0アイテムが返されるシナリオが発生する場合があります。 //public ZCNoSQLQueryHelper withOtherCondition(ZCNoSQLCondition otherCondition) throws Exception; table.getQueryHelper(<ZCNoSQLPartitionKeyCondition>, <true/false>, <limit>).withOtherCondition(<ZCNoSQLCondition>).queryTable(); 開始キー ページネーションに使用されます。テーブル/インデックスからデータをクエリした際、さらにレコードが存在する場合、開始キーが返されます。次のデータセットを取得するには、前のリクエストのレスポンスからこの値を設定する必要があります。 //public ZCNoSQLQueryHelper withStartKey(ZCNoSQLItem startKey); table.getQueryHelper(&lt;ZCNoSQLPartitionKeyCondition&gt;, &lt;true/false&gt;, &lt;limit&gt;).withStartKey(&lt;ZCNoSQLItem&gt;).queryTable(); -------------------------------------------------------------------------------- title: "NoSQLインデックスのクエリ" description: "Catalyst NoSQLは、非リレーショナル、非SQLのデータストレージ手段を提供する完全マネージドの強力なデータベースです。このページでは、NoSQLテーブルのメタデータを取得するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.187Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/nosql/query-index/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction/) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/insert-item/#InsertNewItem) -------------------------------------------------------------------------------- # NoSQLインデックスのクエリ Catalystでは、インデックスのプライマリキーを使用してアイテムを識別し、NoSQLインデックスをクエリしてデータを取得できます。インデックスを使用すると、メインテーブルのプライマリキーを使用せずにテーブルデータに対して代替クエリを実行できます。Catalystコンソールからインデックスを構成できます。そのため、インデックスのパーティションキーのみ、またはパーティションキーとソートキーの組み合わせを使用してアイテムを取得できます。 注意: Catalystでは、1回のSDK操作でNoSQLテーブルからページネーション付きで最大100個のアイテムを一括で取得できます。 属性、必要な値、および使用するサポートされている演算子を指定して、アイテムを識別するキー条件を定義できます。サポートされる演算子のリストおよびCatalystコンソールからのクエリに関するヘルプセクションを参照してください。 ZCNoSQLTableインスタンスでデータをクエリするには、以下を使用します。 //public ZCNoSQLResponseBean queryIndex(Long indexID, ZCNoSQLPartitionKeyCondition partitionKeyCondition, boolean forwardScan, int limit) throws Exception; table.queryIndex(&lt;indexID&gt;, &lt;ZCNoSQLPartitionKeyCondition&gt;, &lt;true/false&gt;, &lt;limit&gt;); ZCNoSQLQueryHelperでクエリする場合 ZCNoSQLQueryHelper このクラスは、インデックスからデータをクエリし、その他の条件、ソート順、制限などを指定するために使用できます。ZCNoSQLTableインスタンスから取得できます。 //public ZCNoSQLQueryHelper getQueryHelper(ZCNoSQLPartitionKeyCondition partitionKeyCondition, boolean forwardScan, int limit) throws Exception; //public ZCNoSQLResponseBean queryTable() throws Exception; table.getQueryHelper(&lt;ZCNoSQLPartitionKeyCondition&gt;, &lt;true/false&gt;, &lt;limit&gt;).queryIndex(&lt;indexID&gt;); ZCNoSQLPartitionKeyCondition 上記で説明した同じパーティションキー条件をここでも再利用できます。 ZCNoSQLQueryHelperで利用可能なその他のメソッド 必要な属性 上記で説明した同じ必要な属性をここでも再利用できます。 Consistency Catalyst NoSQLでは、consistent_readを使用して読み取り操作をマスターまたはスレーブクラスターのどちらで実行するかを指定する、返される行数を制限する、昇順でソート順を指定するなど、クエリの他の要素も定義できます。 注意: マスター・スレーブレプリケーションでは、マスターにデータベースのすべてのデータが含まれ、スレーブにマスターからのコピーが含まれます。スレーブから読み取り操作を実行すると、全体的なコストを削減できますが、更新されたデータの反映にわずかな遅延が生じるトレードオフがあります。 セカンダリキー条件 上記で説明した同じセカンダリキー条件をここでも再利用できますが、インデックスではadditionalSortキーは使用できない点が異なります。 その他の条件 テーブルのクエリで説明したその他の条件もここで再利用できます。 開始キー 上記で説明した同じ開始キーをここでも使用できます。 すべての組み合わせを使用したインデックスクエリ table.getQueryHelper(ZCNoSQLPartitionKeyCondition&gt;, &lt;true/false&gt;, &lt;limit&gt;) .withSecondaryKSeyCondition(&lt;ZCNoSQLSecondaryKeyCondition&gt;, false) .withOtherCondition(&lt;ZCNoSQLCondition&gt;) .withRequiredAttributes(&lt;List of ZCNoSQLAttributes&gt;) .withConsistency(true/false) .withStartKey(&lt;ZCNoSQLItem&gt;) .queryIndex(&lt;indexID&gt;); -------------------------------------------------------------------------------- title: "テーブルからアイテムを削除" description: "Catalyst NoSQLは、非リレーショナル、非SQLのデータストレージ手段を提供する完全マネージドの強力なデータベースです。このページでは、NoSQLテーブルのメタデータを取得するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.187Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/nosql/delete-items/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction/) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/insert-item/#InsertNewItem) -------------------------------------------------------------------------------- # NoSQLテーブルからアイテムを削除 テーブルのプライマリキーを使用してアイテムを識別し、CatalystのNoSQLテーブルからアイテムを削除できます。例えば、パーティションキーのみ、またはパーティションキーとソートキーの組み合わせを使用してアイテムを識別します。 注意: Catalystでは、1回のSDK操作でNoSQLテーブルから最大25個のアイテムを一括で削除できます。 ZCNoSQLTableインスタンスを使用して条件なしでデータを削除するか、リクエストの各部分を構築するために使用できるZCNoSQLDeleteHelperインスタンスを使用して条件付きで削除できます。 ZCNoSQLTableインスタンスでデータを削除するには、以下を使用します。 //public ZCNoSQLResponseBean delete(ZCNoSQLItem key) throws Exception; table.delete(&lt;ZCNoSQLItem&gt;); ZCNoSQLDeleteHelperで削除する場合 ZCNoSQLDeleteHelper このクラスは、条件付きでテーブルからデータを削除するために使用できます。ZCNoSQLTableインスタンスから取得できます。 //public ZCNoSQLDeleteHelper getDeleteHelper(ZCNoSQLItem keys) throws Exception; //public ZCNoSQLResponseBean delete() throws Exception; table.getDeleteHelper(&lt;ZCNoSQLItem&gt;).delete(); ZCNoSQLDeleteHelperで利用可能なその他のメソッド ZCNoSQLCondition 上記で説明した同じ条件を削除に再利用できます。 NOSQL_RETURN_VALUE 上記で説明した同じ条件を削除に再利用できます。 条件と戻り値を指定した削除 table.getDeleteHelper(&lt;ZCNoSQLItem&gt;).withCondition(&lt;ZCNoSQLCondition&gt;).withReturnValue(&lt;NOSQL_RETURN_VALUE&gt;).delete(); ##### Stratus -------------------------------------------------------------------------------- title: "概要" description: "このページでは、コードを通じてStratus操作を実行するために必要なすべてのJava SDKメソッドを一覧で示します。" last_updated: "2026-06-10T06:04:54.187Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/overview/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/overview/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/overview/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Stratus ## 概要 Cloud Scale Stratusは、Catalystの堅牢で強力なストレージソリューションです。バケットと呼ばれるコンテナに、あらゆる形式のデータをオブジェクトとして保存できます。各バケットおよびバケット内の個々のオブジェクトには、安全なオブジェクトURLとバケットURLがあります。オブジェクトに対してアップロードおよびダウンロード操作を実行でき、各オブジェクトにカスタム権限を付与することもできます。 以下の表には、コードを通じてStratus操作を実行するために使用できるすべてのCatalyst SDKの一覧が含まれています。 <table class="content-table"> <thead> <tr> <th class="w30p">カテゴリ</th> <th class="w70p">SDKメソッド</th> </tr> </thead> <tbody> <tr> <td>一般的なStratus操作</td> <td> <ul> <li>Stratusインスタンスの作成</li> <li>バケットの可用性確認</li> <li>バケットの一覧取得</li> </ul> </td> </tr> <tr> <td>バケット操作</td> <td> <ul> <li>バケットインスタンスの作成</li> <li>バケットの詳細取得</li> <li>バケットCORSの取得</li> <li>バケット内のオブジェクト一覧取得 <ul> <li>ページネーションによる全オブジェクトの一覧取得</li> <li>イテレーションによるオブジェクトの一覧取得</li> </ul> </li> <li>オブジェクトの可用性確認</li> <li>オブジェクトのダウンロード <ul> <li>オブジェクトの一部をダウンロード</li> <li>Transfer Managerを使用したオブジェクトのダウンロード</li> <li>オブジェクトダウンロード用のPresigned URLの生成</li> <li>有効期限およびアクティブ時間付きPresigned URLの生成</li> </ul> </li> <li>オブジェクトのアップロード <ul> <li>ストリームとしてオブジェクトをアップロード</li> <li>文字列としてオブジェクトをアップロード</li> <li>オプション付きでオブジェクトをアップロード</li> <li>マルチパート操作によるオブジェクトのアップロード</li> <li>Transfer Managerを使用したオブジェクトのアップロード</li> <li>オブジェクトアップロード用のPresigned URLの生成</li> <li>有効期限およびアクティブ時間付きPresigned URLの生成</li> </ul> </li> <li>Zipオブジェクトの展開</li> <li>オブジェクトのコピー</li> <li>オブジェクトの名前変更および移動操作</li> <li>オブジェクトの削除 <ul> <li>単一オブジェクトの削除</li> <li>複数オブジェクトの削除</li> <li>バケットのトランケート</li> <li>バケット内のパスの削除</li> </ul> </li> </ul> </td> </tr> <tr> <td>オブジェクト操作</td> <td> <ul> <li>オブジェクトインスタンスの作成</li> <li>オブジェクトのバージョン一覧取得 <ul> <li>オブジェクトの全バージョンの一覧取得</li> <li>イテラブル方式でのオブジェクトの全バージョンの一覧取得</li> </ul> </li> <li>オブジェクトの詳細取得 <ul> <li>オブジェクトの詳細の取得</li> <li>特定バージョンのオブジェクトの詳細の取得</li> </ul> </li> <li>オブジェクトメタデータの設定</li> </ul> </td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "Stratusインスタンスの作成" description: "このページでは、Stratusインスタンスを作成するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.188Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/create-stratus-instance/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/create-stratus-instance/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/create-stratus-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/initialize-stratus-instance/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/create-bucket-instance/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/initialize-stratus/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Stratusインスタンスの作成 以下に示すように、stratusコンポーネントの参照を取得できます。これはサーバーサイドの呼び出しを行いません。Stratusの各種コードスニペットでは、このコンポーネントインスタンスを参照します。 #### サンプルコードスニペット <br> import com.zc.component.stratus.ZCStratus; ZCStratus stratus = ZCStratus.getInstance(); -------------------------------------------------------------------------------- title: "バケットの可用性確認" description: "このページでは、プロジェクト内にバケットが存在するかを確認するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.188Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/check-bucket/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/check-bucket/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/check-bucket/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/check-bucket/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # バケットの可用性確認 headBucket() SDKメソッドを使用して、Stratus内のバケットの存在を確認し、さらにユーザーがバケット内のオブジェクトにアクセスするための適切な権限を持っているかどうかを確認できます。 このSDKを使用した場合に返される可能性のあるレスポンス： * バケットが存在し、ユーザーがバケットにアクセスするための適切な権限を持っている場合、レスポンスとして「**true**」が返されます。 * バケットが存在しない場合、またはユーザーがバケットにアクセスする権限を持っていない場合、レスポンスとして「**false**」が返されます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>bucket_name</td> <td>String</td> <td>必須パラメータです。バケットの一意の名前を保持します。</td> </tr> <tr> <td>throwErr</td> <td>Boolean</td> <td>任意パラメータです。このパラメータを「true」に設定すると、バケットがプロジェクト内に見つからない場合にエラーをスローします。デフォルト値は「false」です。</td> </tr> </tbody> </table> Boolean throwErr = false; Boolean res = stratus.headBucket("bucket_name", throwErr); System.out.println(res); #### 発生する可能性のあるエラー Note: throw_errパラメータを使用してSDKを利用し、オブジェクトが存在しない場合、または十分な権限がない場合、以下のいずれかのエラーが発生する可能性があります。 <table class="content-table"> <thead> <tr> <th class="w30p">エラーコード</th> <th class="w70p">意味</th> </tr> </thead> <tbody> <tr> <td>404</td> <td>Not Found。バケットがStratus内に見つかりません。</td> </tr> <tr> <td>401</td> <td>Unauthorized/Access Denied - ユーザーが特定の操作を実行する権限を持っていません。</td> </tr> <tr> <td>403</td> <td>Permission Denied - ユーザーが特定のバケットにアクセスする権限を持っていません。</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "バケットの一覧取得" description: "このページでは、プロジェクト内に作成されたバケットを一覧取得するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.188Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/list-buckets/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/list-buckets/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/list-buckets/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # バケットの一覧取得 以下のSDKメソッドは、プロジェクト内に存在するすべてのバケットを返します。以下のコードスニペットで使用されているStratus参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 #### サンプルコードスニペット <br> import java.util.List; import com.zc.component.stratus.ZCStratus; import com.zc.component.stratus.ZCBucket; ZCStratus stratus = ZCStratus.getInstance(); List&lt;ZCBucket&gt; buckets = stratus.listBuckets(); // 組織内のすべてのバケットを返す -------------------------------------------------------------------------------- title: "バケットインスタンスの作成" description: "このページでは、バケットインスタンスを作成するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.189Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/create-bucket-instance/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Create a Bucket Help Documentation (/ja/cloud-scale/help/stratus/buckets/create-bucket/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/create-bucket-instance/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/create-bucket-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # バケットインスタンスの作成 バケットレベルの操作を実行するには、バケットインスタンスを作成する必要があります。Stratusのバケットに関する各種コードスニペットでは、このコンポーネントインスタンスを参照します。以下のコードスニペットで使用されているStratus参照は、コンポーネントインスタンスです。 #### サンプルコードスニペット <br> import com.zc.component.stratus.ZCBucket; ZCBucket bucket = stratus.bucketInstance("bucketName"); -------------------------------------------------------------------------------- title: "バケットの詳細取得" description: "このページでは、バケットの詳細を取得するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.189Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/get-bucket-details/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Create a Bucket Help Documentation (/ja/cloud-scale/help/stratus/buckets/create-bucket/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/create-bucket-instance/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/create-bucket-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # バケットの詳細取得 getDetails() SDKメソッドを使用して、プロジェクトから単一のバケットの詳細を取得します。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 #### サンプルコードスニペット <br> import com.zc.component.stratus.ZCBucket; ZCBucket bucketDetails = bucket.getDetails(); // バケットの詳細を返す -------------------------------------------------------------------------------- title: "バケットCORSの取得" description: "このページでは、バケットの現在のCORS設定を取得するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.189Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/get-bucket-cors/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Stratus Bucket CORS Help Documentation (/ja/cloud-scale/help/stratus/stratus-config/bucket-cors/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/get-bucket-cors/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/get-bucket-cors/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # バケットCORSの取得 getCors() SDKメソッドは、Stratus内の特定のバケットの現在のCORS設定を返します。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 バケットのCORSは、プロファイルと権限セクションを使用して、プロジェクト内のStratusコンポーネントに対するWrite権限を持つ、または付与されたユーザーが編集できます。 Note: バケットCORSの詳細については、こちらのヘルプセクションを参照してください。 #### サンプルコードスニペット <br> import com.zc.component.stratus.beans.ZCStratusCorsResponse; import java.util.List; List&lt;ZCStratusCorsResponse&gt; res = bucket.getCors(); for(ZCStratusCorsResponse cors: res){ System.out.println(cors.getDomain()); } -------------------------------------------------------------------------------- title: "バケット内のオブジェクト一覧取得" description: "このページでは、バケットに格納されているオブジェクトを取得するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.189Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/list-objects/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/list-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/list-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/get-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/get-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/get-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # バケット内のオブジェクト一覧取得 ### ページネーションによる全オブジェクトの一覧取得 このSDKメソッドを使用すると、特定のバケットに存在するすべてのオブジェクトをページネーションで取得できます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 各呼び出しでは、限られた数のオブジェクトが返され、次の呼び出しはcontinuationトークンが返された場合にのみ開始されます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>maxKey</td> <td>String</td> <td>必須パラメータです。ページネーションで一覧取得できるオブジェクトの最大数を指定します。</td> </tr> <tr> <td>nextToken</td> <td>String</td> <td>必須パラメータです。次のオブジェクトセットを取得するためのトークンを保持します。</td> </tr> <tr> <td>prefix</td> <td>String</td> <td>任意パラメータです。プレフィックス値に一致するオブジェクトを一覧取得します。</td> </tr> <tr> <td>orderBy</td> <td>String</td> <td>任意パラメータです。オブジェクトを昇順または降順で一覧取得します。デフォルト値：asc</td> </tr> </tbody> </table> 取得したレスポンスには、バケットの以下のプロパティが含まれ、moreOptionsに格納されます： * key count：返されるオブジェクトの数の値を保持します * max keys：返すことができるオブジェクトの最大数 * Truncated：バケットがトランケートされているかどうかを通知するステータスを保持します * contents：オブジェクトの詳細のリスト * continuation_token：リクエストでcontinuation_tokenを送信した場合、レスポンスに表示されます * next_continuation_token：レスポンスがトランケートされた場合、このキーの値を次のオブジェクトセットを取得するために同じメソッドにcontinuation_tokenとして渡す必要があります 各イテレーションでmaxKeyの数のオブジェクトを一覧取得し、nextTokenが作成されたかどうかを確認します。nextTokenを使用して、すべてのオブジェクトが一覧取得されるまでイテレーションを続行します。 **以下のパッケージがインポートされていることを確認してください：** import com.zc.component.stratus.ZCBucket; import com.zc.component.stratus.ZCStratus; import com.zc.component.stratus.beans.ZCListObjectOptions; import com.zc.component.stratus.beans.ZCPagedObjectResponse; import com.zc.component.stratus.ZCObject; String nextToken = null; String maxKey = "10"; String prefix = "Sam"; do { ZCListObjectOptions options = new ZCListObjectOptions(); options.setMaxKey(maxKey); // デフォルト: 1000 options.setContinuationToken(nextToken); // 次のページを取得 options.setFolderListing("true"); // デフォルト: false options.setOrderBy("desc"); // デフォルト: "asc" options.setPrefix(prefix); // オプション ZCPagedObjectResponse res = bucket.listPagedObjects(options); System.out.println("Object count: " + res.getKeyCount()); System.out.println("Max key: " + res.getMaxKey()); System.out.println("Is truncated: " + res.getTruncated()); for (ZCObject key : res.getContents()) { System.out.println("Object name: " + key.getKey()); System.out.println("Content type: " + key.getContentType()); System.out.println("Size: " + key.getSize()); System.out.println("Metadata: " + key.getMetaData()); System.out.println("Version ID: " + key.getVersionId()); System.out.println("ETag: " + key.getEtag()); System.out.println("Object type: " + key.getKeyType()); System.out.println("Cached URL: " + key.getCachedUrl()); } nextToken = res.getNextToken(); } while (nextToken != null); ### イテレーションによるオブジェクトの一覧取得 このSDKメソッドを使用すると、イテレーション技法を使用して単一のAPI呼び出しでバケット内のすべてのオブジェクトを取得できます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 **以下のパッケージがインポートされていることを確認してください：** import java.util.Iterator; import com.zc.component.stratus.ZCObject; import com.zc.component.stratus.beans.ZCListObjectOptions; import java.util.List; ZCListObjectOptions options = new ZCListObjectOptions(); options.setFolderListing("true"); // デフォルト: false options.setMaxKey("2"); // デフォルト: 1000 options.setOrderBy("desc"); // デフォルト: "asc" // イテラブルオブジェクトリストを取得する Iterable&lt;List&lt;ZCObject&gt;&gt; paginationIterable = bucket.listIterableObjects(options); Iterator&lt;List&lt;ZCObject&gt;&gt; iterator = paginationIterable.iterator(); while (iterator.hasNext()) { List&lt;lZCObject&gt; objectList = iterator.next(); for (ZCObject obj : objectList) { System.out.println(obj.getKey()); } } -------------------------------------------------------------------------------- title: "オブジェクトの可用性確認" description: "このページでは、バケット内にオブジェクトが存在するかを確認するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.189Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/check-object-availability/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Objects Help Documentation (/ja/cloud-scale/help/stratus/objects/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/check-object-availability/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/check-object-availability/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトの可用性確認 このSDKメソッドを使用して、特定のオブジェクトがバケット内に存在するか、またユーザーがそのオブジェクトにアクセスするために必要な権限を持っているかを確認できます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 バケットでバージョニングを有効にしている場合、特定のバージョンのオブジェクトが利用可能かどうかを確認するために、パラメータとしてversionIDを渡す必要があります。 このSDKメソッドを使用すると、以下のいずれかのレスポンスが返されます： - **true**：オブジェクトが利用可能で、指定されたバージョンが利用可能で、ユーザーがオブジェクトにアクセスするための適切な権限を持っている場合。 - **false**： - オブジェクトまたは特定のバージョンのオブジェクトがバケット内に利用できない場合。 - ユーザーがオブジェクトにアクセスするために必要な権限を持っていない場合。 - バケットが存在しない場合。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトの完全な名前を保持します。</td> </tr> <tr> <td>versionId</td> <td>String</td> <td>任意パラメータです。バージョニングが有効な場合、オブジェクトの一意のバージョンIDを保持します。</td> </tr> <tr> <td>throwErr</td> <td>Boolean</td> <td>任意パラメータです。このパラメータを「true」に設定すると、オブジェクトがプロジェクト内に見つからない場合にエラーをスローします。デフォルト値は「false」です。</td> </tr> </tbody> </table> Boolean throwErr = true; Boolean headObjectRes = bucket.headObject("sam/out/sample.txt", "versionId", throwErr); System.out.println(headObjectRes); **発生する可能性のあるエラー** Note: throw_errパラメータを使用してSDKを利用し、オブジェクトが存在しない場合、または十分な権限がない場合、以下のいずれかのエラーが発生する可能性があります。 <table class="content-table"> <thead> <tr> <th class="w30p">エラーコード</th> <th class="w70p">意味</th> </tr> </thead> <tbody> <tr> <td>404</td> <td>Not Found。オブジェクトが見つかりません。</td> </tr> <tr> <td>401</td> <td>Unauthorized/Access Denied - ユーザーが特定の操作を実行する権限を持っていません。</td> </tr> <tr> <td>403</td> <td>Permission Denied - ユーザーが特定のオブジェクトにアクセスする権限を持っていません。</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "オブジェクトのダウンロード" description: "このページでは、バケットからオブジェクトをダウンロードするためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.190Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/download-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Download Object Help Documentation (/ja/cloud-scale/help/stratus/objects/manage-object/download-object/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/download-object/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/download-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/download-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/download-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/download-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトのダウンロード このセクションのSDKを使用すると、特定のオブジェクトまたはオブジェクトのバージョンをダウンロードできます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 ダウンロード操作の最初のステップは、バケットから必要なオブジェクトを取得するGET操作です。 オブジェクトをダウンロードするには、リクエスターにREADアクセス権限が必要です。ただし、バケットの所有者は、必要なレスポンスヘッダーを使用せずにオブジェクトをダウンロードできるよう、ユーザーにREADアクセス権限を付与するオプションがあります。 バケットでバージョニングが有効な場合、特定のバージョンのオブジェクトをダウンロードするにはversionIdを渡す必要があります。versionIdが渡されない場合、デフォルトでオブジェクトの最新バージョンがダウンロードされます。 バケットで*バージョニング*が有効にされた後、無効にされた場合、デフォルトでプリンシパルの最初のオブジェクトがダウンロードされます。このオブジェクトの最新バージョンをダウンロードするには、versionIdパラメータに値「topVersion」を渡す必要があります。 #### サンプルコードスニペット <br> import java.nio.file.Path; import java.nio.file.Files; import java.nio.file.StandardCopyOption; import java.io.*; InputStream dataStream = bucket.getObject("sam/out/sample.txt"); // オブジェクトをローカルマシンにダウンロードする Path path = Path.of("file_path"); // ダウンロードしたオブジェクトを保存するパスを指定する Files.copy(dataStream, path, StandardCopyOption.REPLACE_EXISTING); ### オブジェクトの一部をダウンロード 以下のSDKはsetRange()メソッドを実装しています。このメソッドを使用すると、オブジェクトの特定のバイト範囲をダウンロードできます。 #### サンプルコードスニペット <br> import com.zc.component.stratus.beans.ZCGetObjectOptions; import java.nio.file.Path; import java.nio.file.Files; import java.nio.file.StandardCopyOption; import java.io.*; // ダウンロードオプションを追加する ZCGetObjectOptions options = ZCGetObjectOptions.getInstance(); options.setVersionId("3yt5ehjbjghds3i28"); options.setRange("20-200"); // オブジェクトのバイト単位の開始・終了範囲 InputStream dataStream = bucket.getObject("sam/out/sample.txt", options); // オブジェクトをローカルマシンにダウンロードする Path path = Path.of("file_path"); // ダウンロードしたオブジェクトを保存するパスを指定する Files.copy(dataStream, path, StandardCopyOption.REPLACE_EXISTING); ### Transfer Managerを使用したオブジェクトのダウンロード このセクションでは、**Transfer Manager**技法を使用して、Stratusからローカルシステムに大きなオブジェクトを正常にダウンロードするためのSDKメソッドを説明します。Transfer Managerは、大きなオブジェクトをオブジェクトの開始バイトと終了バイトの範囲を使用して複数のバイト範囲に分割する操作です。オブジェクトの各パーツはストリームとして返され、ローカルシステムにダウンロードされます。 #### Transfer Managerインスタンスの作成 #### サンプルコードスニペット <br> import com.zc.component.stratus.transfer.ZCTransferManager; ZCTransferManager transferManager= ZCTransferManager.getInstance(bucket); #### イテラブルパーツストリームとしてオブジェクトをダウンロード #### サンプルコードスニペット <br> import java.nio.file.StandardOpenOption; import java.nio.file.Files; import java.util.Iterator; import java.nio.file.Path; import java.io.*; Iterable &lt;InputStream&gt; Iterable = transferManager.getIterableObject("sam/out/sample.txt", 100 L); Path path = Path.of("file_path"); Iterator &lt;InputStream&gt; res = Iterable.iterator(); while (res.hasNext()) { InputStream data = res.next(); // オブジェクトの各パーツをストリームとして取得する Files.copy(data, path, StandardCopyOption.REPLACE_EXISTING); // ストリームをローカルファイルパスに書き込む } #### ダウンロード用のオブジェクトパーツの生成 このSDKメソッドでは、必要な開始バイトと終了バイトの範囲内にあるオブジェクトの一部をダウンロードします。 **使用パラメータ** * PartSize：各パーツのサイズ（MB単位） * key：オブジェクトの名前を保持します #### サンプルコードスニペット <br> import java.nio.file.StandardOpenOption; import java.nio.file.Files; import com.zc.component.stratus.beans.ZCStratusGetObject; import java.nio.file.Path; import java.io.*; Path path = Path.of("file_path"); // パート関数のリストを取得する List&lt;ZCStratusGetObject&gt; parts = transferManager.generatePartDownloaders("sam/out/sample.txt", 100L); // ダウンロードしたストリームを保存するファイルを作成する。 Files.createFile(path); int partNumber = 1; // 各関数をトリガーしてオブジェクトパーツをダウンロードする for (ZCStratusGetObject part : parts) { // オブジェクトパーツをストリームとして取得する InputStream inputStream = part.getPart(); System.out.println("Part "+ partNumber++ + " Downloaded"); // ストリームデータをローカルマシンに書き込む Files.write(path, inputStream.readAllBytes(), StandardOpenOption.APPEND); } ### オブジェクトダウンロード用のPresigned URLの生成 Presigned URLは、認証済みユーザーが非認証ユーザーと共有できる安全なURLです。このURLにより、非認証ユーザーにオブジェクトへのアクセスに対する一時的な認可が提供されます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトの完全な名前とパスを保持します。</td> </tr> <tr> <td>URL_ACTION</td> <td>Enum</td> <td>必須パラメータです。ダウンロードアクション用のPresigned URLを生成するためのパラメータです。 <ul> <li>**URL_ACTION.GET**：オブジェクトをダウンロードする場合</li> </ul> </td> </tr> <tr> <td>expiry</td> <td>String</td> <td>任意パラメータです。URLの有効時間（秒単位）。 <ul> <li>デフォルト値：3600秒</li> <li>最小値：30秒</li> <li>最大値：7日</li> </ul> </td> </tr> <tr> <td>activeFrom</td> <td>String</td> <td>任意パラメータです。このパラメータには、URLが有効になるまでの時間を指定します。最大値は7日です。デフォルトでは、URLは生成されるとすぐにアクティブになります。</td> </tr> </tbody> </table> #### サンプルコードスニペット <br> import com.zc.component.stratus.enums.URL_ACTION; import org.json.simple.JSONObject; JSONObject res = bucket.generatePreSignedUrl("sam/out/sample.txt",URL_ACTION.GET); System.out.println(res.get("signature")); ### 有効期限およびアクティブ時間付きPresigned URLの生成 #### サンプルコードスニペット <br> import com.zc.component.stratus.enums.URL_ACTION; import org.json.simple.JSONObject; JSONObject res = bucket.generatePreSignedUrl("object_name",URL_ACTION.GET, "expiry_in","active_from"); System.out.println(res.get("signature")); **ダウンロード用Presigned URLの生成のレスポンス例** { signature: 'https://sadi-development.zoho stratus.com/_signed/text.txt?organizationId=96862383&stsCredential=96858154-96862383&stsDate=1747896279887&stsExpiresAfter=300&stsSignedHeaders=host&stsSignature=3YBUX1HFSxNQzQJjFrln82AyJsEEuC5T9dsZwWxGyEE' } **Presigned URLを使用したオブジェクトアップロードの使用例スニペット** import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.Response; import okhttp3.ResponseBody; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; public class Download { public static void main(String[] args) throws IOException { // HTTPリクエストを処理するOkHttpClientインスタンスを作成する OkHttpClient client = new OkHttpClient(); // 署名付きURLでGETリクエストを構築する Request request1 = new Request.Builder() .url("https://sadi-development.zohostratus.com/_signed/sam.txt?organizationId=96862383&stsCredential=96858154-96862383&stsDate=1747905744487&stsExpiresAfter=300&stsSignedHeaders=host&stsSignature=pCjV9xckDOqBCueE_gBeMbp12StddTghBK_8HUwU5k0") // Replace with your actual URL .build(); // リクエストを実行してレスポンスを処理する try (Response response1 = client.newCall(request1).execute()) { // レスポンスが成功したかどうか確認する if (!response1.isSuccessful()) { throw new IOException("Unexpected code " + response1); } // レスポンスボディをInputStreamとして取得する ResponseBody body = response1.body(); if (body != null) { // ファイルをディスクに書き込むストリームを作成する try (InputStream in = body.byteStream(); OutputStream out = new FileOutputStream("file_path")) { // file_pathを実際のパスに置き換えてください // レスポンスデータをチャンクで読み取りファイルに書き込む byte[] buffer = new byte[8192]; int len; while ((len = in.read(buffer)) != -1) { out.write(buffer, 0, len); } // ダウンロード成功後に確認メッセージを表示する System.out.println("Download complete."); } } } catch (IOException e) { // ダウンロード中にエラーが発生した場合にスタックトレースを表示する e.printStackTrace(); } } } -------------------------------------------------------------------------------- title: "オブジェクトのアップロード" description: "このページでは、バケットにオブジェクトをアップロードするためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.190Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/upload-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Upload Object Help Documentation (/ja/cloud-scale/help/stratus/objects/upload-object/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/upload-object/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/upload-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/upload-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/upload-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/upload-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/upload-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトのアップロード このセクションに記載されているSDKメソッドを使用すると、さまざまな方法でバケットにオブジェクトをアップロードできます。オブジェクトを**文字列**または**ストリーム**としてアップロードできます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 オブジェクトに対してバージョニングが有効になっていない場合、Stratusが同じオブジェクトに対して複数の書き込みリクエストを受け取ると、オブジェクトは継続的に上書きされます。最新のアップロードのオブジェクトのみが保存されます。 ただし、バージョニングを有効にすると、各アップロードはオブジェクトのバージョンとみなされ、すべてが一意のversionIdとともにバケットに保存されます。 Note: パスまたはオブジェクトを作成する際、スペースを含む以下の文字はサポートされていません：ダブルクォート、両方の山括弧、ハッシュタグ、バックスラッシュ、パイプ記号。 ### ストリームとしてオブジェクトをアップロード このSDKメソッドを使用して、ストリームとしてバケットにオブジェクトをアップロードできます。ストリームを変数に格納してから、その変数をアップロードメソッドに渡します。 #### サンプルコードスニペット <br> import com.zc.component.stratus.beans.ZCPutObjectOptions; import java.nio.file.Path; import java.nio.file.Files; import java.nio.file.StandardCopyOption; import java.io.*; InputStream file =new FileInputStream("filePath"); Boolean res = bucket.putObject("sam/out/sample.txt", file); System.out.println(res); ### 文字列としてオブジェクトをアップロード このSDKメソッドを使用して、オブジェクトを文字列としてアップロードできます。アップロードメソッドputObject()にオブジェクト名とオブジェクトに格納するデータを文字列形式で渡します。 #### サンプルコードスニペット <br> import com.zc.component.stratus.beans.ZCPutObjectOptions; import java.nio.file.Path; import java.nio.file.Files; import java.nio.file.StandardCopyOption; import java.io.*; Boolean res = bucket.putObject("sam/out/sample.txt", "content of the file"); System.out.println(res); ### オプション付きでオブジェクトをアップロード このSDKメソッドを使用して、オブジェクトのアップロード時に以下のオプションを使用できます。 * **setOverwrite()**：バケットの*バージョニング*が有効になっていない場合に使用できるオプションです。バージョニングなしでリソースを上書きする場合にこのオプションを使用する必要があります。デフォルト値は「**false**」です。 * **setTTL()**：オブジェクトの**Time-to-Live**（TTL）を秒単位で設定するためのオプションです。値は**60秒**以上である必要があります。 * **setMetaData()**：アップロードするオブジェクトのメタ詳細をアップロードするためのオプションです。 * **contentType**：オブジェクトのMIMEタイプを設定する必要がある場合に使用できるオプションです。 #### サンプルコードスニペット <br> import com.zc.component.stratus.beans.ZCPutObjectOptions; import java.nio.file.Path; import java.nio.file.Files; import java.nio.file.StandardCopyOption; import java.util.Map; import java.io.*; ZCPutObjectOptions options = ZCPutObjectOptions.getInstance(); options.setTTL("1000"); options.setOverwrite("true"); Map&lt;String, String&gt; metaData = new HashMap&lt;String, String&gt;(); metaData.put("author", "John"); options.setMetaData(metaData); InputStream file = new FileInputStream("filePath"); Boolean res = bucket.putObject("sam/out/sample.txt", file, options); System.out.println(res); ### 展開オプション付きでオブジェクトをアップロード putZipObject() SDKメソッドを使用してZipオブジェクトをアップロードすると、Zip内のオブジェクトが展開されてアップロードされます。 #### サンプルコードスニペット <br> import com.zc.component.stratus.ZCBucket; import com.zc.component.stratus.ZCStratus; import com.zc.component.stratus.beans.ZCPutObjectOptions; ZCStratus stratus = ZCStratus.getInstance(); ZCBucket bucket = stratus.bucketInstance("sam1"); ZCPutObjectOptions options = ZCPutObjectOptions.getInstance(); options.setOverwrite("true"); InputStream stream = new FileInputStream("file_path"); JSONObject object = bucket.putZipObject("sam.zip", stream, options); このSDKメソッドはtaskIdの値を返します。この値を使用して、こちらのSDKメソッドで展開のステータスを確認できます。 **レスポンス例** { 'task_id': '1234263749' } ### マルチパート操作によるオブジェクトのアップロード アップロードするオブジェクトが大きすぎてアップロードできない場合、マルチパート操作を実行できます。マルチパート操作では、オブジェクトを複数のパーツに分割し、より高速なアップロードを実行します。このSDKセクションでは、Stratusでオブジェクトのマルチパートアップロードを実行するために利用可能なすべてのSDKメソッドを説明します。 #### マルチパートアップロードの開始 以下のSDKメソッドを使用して、uploadIdを返します。このIDにより、オブジェクトの複数のパーツをアップロードできます。 #### サンプルコードスニペット <br> import com.zc.component.stratus.beans.ZCInitiateMultipartUpload; ZCInitiateMultipartUpload multipart = bucket.initiateMultipartUpload("sam/out/sample.txt"); #### オブジェクトのパーツのマルチパートアップロードの実行 以下のSDKメソッドでは、オブジェクトの個々のパーツのアップロードを実行します。各パーツには**1から1000**の範囲の固有のpart_numberがあります。これはパーツの順序を表しますが、これらのパーツは必ずしも順番にアップロードされるわけではありません。オブジェクトのすべてのパーツのアップロードが完了すると、これらのパーツは順番に結合されます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトの名前を保持します。</td> </tr> <tr> <td>uploadId</td> <td>String</td> <td>必須パラメータです。この値はマルチパートアップロードの開始メソッドで返されます。</td> </tr> <tr> <td>part</td> <td>InputStream</td> <td>必須パラメータです。オブジェクトパーツのデータを保持します。</td> </tr> <tr> <td>partNumber</td> <td>Int</td> <td>必須パラメータです。アップロードされるパーツの順序を保持します。</td> </tr> </tbody> </table> #### サンプルコードスニペット <br> import java.io.*; int partNumber = 1; InputStream part = new FileInputStream("filePath"); Boolean res = bucket.uploadPart("sam/out/sample.txt", "uploadId", part, partNumber); System.out.println(res); #### マルチパートアップロードのサマリー取得 以下のSDKメソッドを使用して、アップロードされたすべてのパーツの操作サマリーを取得できます。サマリーを表示するには、getMultipartUploadSummary()メソッドにuploadIdを渡します。 #### サンプルコードスニペット <br> import com.zc.component.stratus.beans.ZCMultipartObjectSummary; ZCMultipartObjectSummary summaryRes = bucket.getMultipartUploadSummary("sam/out/sample.txt", "uploadId"); // アップロード済みパーツにアクセスする System.out.println("Object Name:" + summaryRes.getKey()); System.out.println("Upload Id:" + summaryRes.getUploadId()); System.out.println("Status:" + summaryRes.getStatus()); System.out.println(summaryRes.getParts().get(0).getUploadedAt()); System.out.println(summaryRes.getParts().get(0).getPartNumber()); #### マルチパートアップロード操作の完了 以下のメソッドを使用すると、すべてのパーツが正常にアップロードされた後にマルチパートプロセスを終了できます。プロセスを完了するには、completeMultipartUpload()メソッドにuploadIdを渡します。 Boolean completeRes = bucket.completeMultipartUpload("sam/out/sample.txt", "uploadId"); System.out.println(completeRes); #### マルチパート操作の実装を示すサンプルスニペット #### サンプルコードスニペット <br> import java.util.concurrent.CompletableFuture; import java.util.concurrent.ExecutionException; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.logging.Logger; import java.util.logging.Level; import java.util.ArrayList; import java.util.List; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import com.catalyst.advanced.CatalystAdvancedIOHandler; import com.zc.component.stratus.ZCBucket; import com.zc.component.stratus.ZCStratus; import com.zc.component.stratus.beans.ZCInitiateMultipartUpload; import com.zc.exception.ZCServerException; import java.io.InputStream; import java.io.FileInputStream; import java.io.ByteArrayInputStream; public class MultipartUpload implements CatalystAdvancedIOHandler { private static final Logger LOGGER = Logger.getLogger(Sample.class.getName()); @Override public void runner(HttpServletRequest request, HttpServletResponse response) throws Exception { try { switch (request.getRequestURI()) { case "/": { ZCStratus stratus = ZCStratus.getInstance(); // バケットインスタンスを取得する ZCBucket bucket = stratus.bucketInstance("sample"); // マルチパートアップロード String key = "sample.mp4"; InputStream file = new FileInputStream( "/users/sam/sample.mp4"); ZCInitiateMultipartUpload initiateUploadResponse = bucket.initiateMultipartUpload(key); String uploadId = initiateUploadResponse.getUploadId(); System.out.println("Multipart upload initiated. Upload ID: " + uploadId); // ファイルサイズとパートサイズ（最小50 MB） int partSize = 50 * 1024 * 1024; // 50 MB long fileSize = file.available(); double result = (double) fileSize / partSize; int noOfParts = (int) Math.ceil(result); // パーツを並列でアップロードする List&lt;CompletableFuture&lt;Void&gt;&gt; uploadedParts = new ArrayList&lt;&gt;(); ExecutorService executor = Executors.newFixedThreadPool(4); int partNumber = 1; while (noOfParts &gt;= partNumber) { int currentPartNumber = partNumber; byte[] buffer = new byte[partSize]; file.read(buffer); InputStream fileData = new ByteArrayInputStream(buffer); uploadedParts.add(CompletableFuture.runAsync(() -&gt; { try { bucket.uploadPart(key, uploadId, fileData, currentPartNumber); LOGGER.log(Level.INFO, "Part {0} Uploaded", currentPartNumber); } catch (Exception e) { throw new RuntimeException(e); } }, executor)); partNumber++; } CompletableFuture&lt;Void&gt; isUploaded = CompletableFuture .allOf(uploadedParts.toArray(new CompletableFuture[0])); try { isUploaded.get(); } catch (Exception e) { throw new ZCServerException("Error while uploading the object", e); } Boolean completeRes = bucket.completeMultipartUpload(key, uploadId); if (completeRes) { LOGGER.log(Level.INFO, "Upload Completed"); } } default: { response.setStatus(404); response.getWriter().write("You might find the page you are looking for at \"/\" path"); } } } catch (Exception e) { if (e instanceof ZCServerException) { int statusCode = ((ZCServerException) e).getStatus(); System.out.println("HTTP status code: " + statusCode); } LOGGER.log(Level.SEVERE, "Exception in Sample", e); } } } ### Transfer Managerを使用したオブジェクトのアップロード #### Transfer Managerインスタンスの作成 #### サンプルコードスニペット <br> import com.zc.component.stratus.transfer.ZCTransferManager; ZCTransferManager transferManager= ZCTransferManager.getInstance(bucket); #### マルチパートアップロード **マルチパートアップロードインスタンスの作成** 以下のSDKメソッドは、マルチパートアップロードを開始してマルチパートインスタンスを作成します。 #### サンプルコードスニペット <br> import com.zc.component.stratus.beans.ZCMultipartUpload; ZCMultipartUpload multipart = transferManager.createMultipartInstance("sam/out/sample.txt"); 既に初期化されたマルチパートアップロード操作用のインスタンスを作成する必要がある場合は、以下のコードスニペットをコピーして使用してください。 ZCMultipartUpload multipart = transferManager.createMultipartInstance("sam/out/sample.txt", "uploadId"); #### パーツのアップロード 以下のSDKメソッドでは、*マルチパートアップロードインスタンスの作成*セクションで初期化したmultipartインスタンスを使用します。 #### サンプルコードスニペット <br> import java.io.InputStream; int partNumber = 1; InputStream part = new FileInputStream("filePath"); Boolean uploadRes = multipart.uploadPart(part, partNumber); System.out.println(uploadRes); #### アップロードサマリー #### サンプルコードスニペット <br> import com.zc.component.stratus.beans.ZCMultipartObjectSummary; ZCMultipartObjectSummary summaryRes = multipart.getUploadSummary(); // アップロード済みパーツにアクセスする System.out.println("Object Name:" + summaryRes.getKey()); System.out.println("Upload Id:" + summaryRes.getUploadId()); System.out.println("Status:" + summaryRes.getStatus()); System.out.println(summaryRes.getParts().get(0).getUploadedAt()); System.out.println(summaryRes.getParts().get(0).getPartNumber()); System.out.println(summaryRes.getParts().get(0).getSize()); #### アップロードの完了 Boolean completeRes = multipart.completeUpload(); System.out.println(completeRes); #### ラッパーを使用したオブジェクトのアップロード 以下のSDKメソッドはラッパーとして機能し、複数のステップを実行することなくマルチパートアップロード操作全体を実行します。このメソッドを使用すると、オブジェクトが複数のパーツに分割され、複数のパーツでバケットにアップロードされ、すべてのパーツがアップロードされると結合されます。 import java.io.InputStream; import com.zc.component.stratus.beans.ZCMultipartObjectSummary; InputStream file =new FileInputStream("filePath"); int partSize = 50; ZCMultipartObjectSummary res = transferManager.putObjectAsParts("objetName", file, partSize); Note: **2GB**を超えるオブジェクトの場合、マルチパートアップロード操作を正常に実行するために個々のSDKメソッドを使用することをお勧めします。 ### オブジェクトアップロード用のPresigned URLの生成 Presigned URLは、認証済みユーザーが非認証ユーザーと共有できる安全なURLです。このURLにより、非認証ユーザーにオブジェクトへのアクセスに対する一時的な認可が提供されます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトの完全な名前とパスを保持します。</td> </tr> <tr> <td>URL_ACTION</td> <td>Enum</td> <td>必須パラメータです。アップロードアクション用のPresigned URLを生成するためのパラメータです。 <ul> <li>**URL_ACTION.PUT**：オブジェクトをアップロードする場合</li> </ul> </td> </tr> <tr> <td>expiry</td> <td>String</td> <td>任意パラメータです。URLの有効時間（秒単位）。 <ul> <li>デフォルト値：3600秒</li> <li>最小値：30秒</li> <li>最大値：7日</li> </ul> </td> </tr> <tr> <td>activeFrom</td> <td>String</td> <td>任意パラメータです。このパラメータには、URLが有効になるまでの時間を指定します。最大値は7日です。デフォルトでは、URLは生成されるとすぐにアクティブになります。</td> </tr> </tbody> </table> #### サンプルコードスニペット <br> import com.zc.component.stratus.enums.URL_ACTION; import org.json.simple.JSONObject; JSONObject res = bucket.generatePreSignedUrl("sam/out/sample.txt", URL_ACTION.PUT); System.out.println(res.get("signature")); ### 有効期限およびアクティブ時間付きPresigned URLの生成 #### サンプルコードスニペット <br> import com.zc.component.stratus.enums.URL_ACTION; import org.json.simple.JSONObject; JSONObject res = bucket.generatePreSignedUrl("object_name",URL_ACTION.GET, "expiry_in","active_from"); System.out.println(res.get("signature")); **アップロード用Presigned URLの生成のレスポンス例** { "signature": "https://sadi-development.zohostratus.com/_signed/sam.txt?organizationId=96862383&stsCredential=96858154-96862383&stsDate=1747904989454&stsExpiresAfter=300&stsSignedHeaders=host&stsSignature=UPyH5A4AdAaCpw6S6jVhKFSxg3B0B0p619YN0cAIn4c", "expiry_in_seconds": "100", "active_from": "1726492859577" } **Presigned URLを使用したオブジェクトアップロードの使用例スニペット** import okhttp3.*; import java.io.File; import java.io.IOException; public class BinaryFileUpload { public static void main(String[] args) throws IOException { // HTTPリクエスト用のOkHttpClientインスタンスを作成する OkHttpClient client = new OkHttpClient(); // アップロードするファイルを指定する。「file_path」を実際のファイルの場所に置き換えてください File file = new File("file_path"); // バイナリコンテンツ（octet-stream）でリクエストボディを作成する RequestBody requestBody = RequestBody.create( MediaType.parse("application/octet-stream"), // 既知の場合は特定のMIMEタイプを使用 file ); // ️ 署名付きURLでPUTリクエストを構築する Request request = new Request.Builder() .url("https://sadi-development.zohostratus.com/_signed/sam.txt?organizationId=96862383&stsCredential=96858154-96862383&stsDate=1747904989454&stsExpiresAfter=300&stsSignedHeaders=host&stsSignature=UPyH5A4AdAaCpw6S6jVhKFSxg3B0B0p619YN0cAIn4c") // Replace with a actual URL .put(requestBody) // ファイルをアップロードするPUTリクエスト .build(); // リクエストを実行してレスポンスを処理する try (Response response = client.newCall(request).execute()) { if (response.isSuccessful()) { System.out.println("Object uploaded successfully"); } else { // アップロード失敗時にエラーを表示する System.err.println("Error: " + response.code() + " - " + response.body().string()); } } } } -------------------------------------------------------------------------------- title: "Zipオブジェクトの展開" description: "このページでは、Zipオブジェクトを展開するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.191Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/extract-zipped-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/extract-zipped-object/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/extract-zipped-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Zipオブジェクトの展開 以下のSDKメソッドを使用すると、Stratus内でZipファイルを展開でき、Zipファイル内の各コンテンツが個別のオブジェクトとして同じバケット内のStratusにアップロードされます。このプロセス全体は*非同期*で実行されます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 Note: 展開プロセスは非同期で実行されるため、プロセス全体が完了するまでの時間は、展開するZipファイルのサイズに依存します。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。展開するZipファイルの名前を指定します。</td> </tr> <tr> <td>destination</td> <td>String</td> <td>必須パラメータです。展開されたオブジェクトがバケット内に保存される宛先の完全なパス情報を指定します。</td> </tr> </tbody> </table> #### サンプルコードスニペット <br> import com.zc.component.stratus.beans.ZCStratusZipExtractResponse; ZCStratusZipExtractResponse res = bucket.unzipObject("sam/out/sample.zip","output/"); System.out.println(res.getObjectName()); System.out.println(res.getTaskId()); ### Zip展開ステータスの取得 Zip展開プロセスは非同期で実行され、展開プロセスの完了に要する時間はZipファイルのサイズに大きく依存します。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 以下のSDKメソッドでtaskIdパラメータを使用して、展開のステータスを確認できます。taskIdはunzipObject()メソッドのレスポンスで返されます。 #### サンプルコードスニペット <br> import org.json.simple.JSONObject; JSONObject res = object.getUnzipStatus("sam/out/sample.zip","taskId"); System.out.println(res); #### レスポンス例 { "task_id": "6963000000272049", "status": "SUCCESS" } -------------------------------------------------------------------------------- title: "オブジェクトのコピー" description: "このページでは、バケット内でオブジェクトのコピーを作成するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.191Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/copy-objects/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/copy-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/copy-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトのコピー このSDKメソッドを使用して、オブジェクトをコピーしてバケット内に貼り付けることができます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 keyはコピーするオブジェクトで、destinationにはコピーされたオブジェクトの新しい名前を指定します。コピーしたオブジェクトを別のパスに貼り付けるには、destinationに完全なパス名を指定する必要があります。 Note: * keyとdestinationの両方の値に、パスとともにオブジェクトの完全な名前を指定する必要があります。 * 例えば、パスpictures/puppyに「kitten.png」というファイルがあり、そのファイルをpictures/kittenパスにコピーする場合：<br /> keyの値は「pictures/puppy/kitten.png」になります<br /> destinationの値は「pictures/kitten/kitten.png」になります<br /> #### サンプルコードスニペット <br> import org.json.simple.JSONObject; JSONObject copyRes = bucket.copyObject("sam/out/sample.txt", "output/sample.txt") System.out.println(copyRes); #### レスポンス例 { "copy_to": "output/sample.txt", "object_key": "sam/out/sample.txt", "message": "Object copied successfully." } -------------------------------------------------------------------------------- title: "オブジェクトの名前変更および移動操作" description: "このページでは、オブジェクトの名前変更および移動操作を実行するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.192Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/rename-move-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/rename-move-object/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/rename-move-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトの名前変更および移動操作 オブジェクトの名前変更および移動には、同じrenameObject() SDKメソッドを使用します。 ### オブジェクトの名前変更 renameObject() SDKメソッドを使用して、バケット内のオブジェクトの名前を変更できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 Note: パスまたはオブジェクトを作成する際、スペースを含む以下の文字はサポートされていません：ダブルクォート、両方の山括弧、ハッシュタグ、バックスラッシュ、パイプ記号。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>名前を変更するオブジェクトの元の名前です。</td> </tr> <tr> <td>destination</td> <td>String</td> <td>オブジェクトに変更する新しい名前です。</td> </tr> </tbody> </table> #### サンプルコードスニペット <br> import org.json.simple.JSONObject; JSONObject res = bucket.renameObject("sam/out/sample.txt", "sam/out/update_sample.txt"); System.out.println(res); Note: バージョニングが有効なバケット内のオブジェクトの名前は変更できません。 ### オブジェクトの移動 renameObject() SDKメソッドを使用して、バケット内のあるパスから別のパスにオブジェクトを移動できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>移動するオブジェクトの完全な名前とパスです。</td> </tr> <tr> <td>destination</td> <td>String</td> <td>オブジェクトの完全な名前と新しいパスです。</td> </tr> </tbody> </table> Note: * keyとdestinationの両方の値に、パスとともにオブジェクトの完全な名前を指定する必要があります。 * 例えば、パスpictures/puppyに「kitten.png」というファイルがあり、そのファイルをpictures/kittenパスに移動する場合：<br /> keyの値は「pictures/puppy/kitten.png」になります<br /> destinationの値は「pictures/kitten/kitten.png」になります<br /> #### サンプルコードスニペット <br> import org.json.simple.JSONObject; JSONObject res = bucket.renameObject("sam/out/sample.txt", "output/sample.txt"); System.out.println(res);<br /> Note: バージョニングが有効なバケットでは移動操作を実行できません。 -------------------------------------------------------------------------------- title: "オブジェクトの削除" description: "このページでは、バケットに格納されているオブジェクトを削除するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.192Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/delete-objects/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Delete an Object Help Documentation (/ja/cloud-scale/help/stratus/objects/manage-object/delete-object/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/delete-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/delete-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/delete-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/delete-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/delete-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/delete-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトの削除 以下のSDKメソッドを使用して、Stratusでの削除操作を実行できます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトの完全な名前とパスを保持します。</td> </tr> <tr> <td>versionId</td> <td>String</td> <td>任意パラメータです。バケットでバージョニングが有効な場合、このパラメータで一意のバージョンIDを使用して特定のバージョンを参照できます。</td> </tr> <tr> <td>ttl</td> <td>int</td> <td>任意パラメータです。削除操作をスケジュールできます。例えば、ttlの値を60に設定すると、削除操作は60秒後に実行されます。ttlの値は60秒以上である必要があります。</td> </tr> </tbody> </table> ### 単一オブジェクトの削除 このSDKメソッドを使用して、deleteObject()メソッドにオブジェクト名を渡すことで、特定のオブジェクトを削除できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 #### サンプルコードスニペット <br> import org.json.simple.JSONObject; int ttl = 200; //有効期限（秒単位） JSONObject deleteRes = bucket.deleteObject("sam/out/sample.txt", "versionId", ttl); System.out.println(deleteRes); Note: バケットでバージョニングが有効で、特定のversionIdが指定されていない場合、オブジェクトを削除すると、デフォルトでそのオブジェクトのすべてのバージョンが削除されます。 ### 複数オブジェクトの削除 このSDKメソッドを使用して、削除するオブジェクトの名前を配列として渡すことで、複数のオブジェクトを削除できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 バケットでバージョニングを有効にしている場合は、オブジェクトのversionIdを指定してください。ttl変数を使用して削除操作をスケジュールすることもできます。例えば、ttlの値を**60**に設定すると、削除操作は**60秒**後に実行されます。 #### サンプルコードスニペット <br> import com.zc.component.stratus.beans.ZCDeleteObjectRequest; import org.json.simple.JSONObject; ZCDeleteObjectRequest deleteRequest = ZCDeleteObjectRequest.getInstance(); deleteRequest.setObject("sam/out/sample.txt", "76dhe7yr738rud"); deleteRequest.setObject("sam/out/add.txt", "cjdhf73673g7yt7d"); deleteRequest.setTTL(70); JSONObject res = bucket.deleteObjects(deleteRequest); System.out.println(res); ### バケットのトランケート このSDKメソッドを使用すると、バケット内に存在するすべてのオブジェクトを削除できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 #### サンプルコードスニペット <br> import org.json.simple.JSONObject; JSONObject truncateRes = bucket.truncate(); System.out.println(truncateRes); ### バケット内のパスの削除 このSDKを使用すると、パス内に存在するすべてのオブジェクトを削除できます。deletePath()メソッドに完全なパスを渡す必要があります。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 #### サンプルコードスニペット <br> import org.json.simple.JSONObject; JSONObject res = bucket.deletePath("sam/"); System.out.println(res); Note: 正確なパスを指定してください。不正確なパスが指定された場合、削除アクションはスケジュールされますが、エラーが発生します。 -------------------------------------------------------------------------------- title: "オブジェクトインスタンスの作成" description: "このページでは、オブジェクトインスタンスを作成するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.192Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/create-object-instance/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/create-object-instance/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/create-object-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトインスタンスの作成 以下のメソッドを使用して、オブジェクト関連の操作を実行するためのオブジェクトインスタンスを取得します。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 #### サンプルコードスニペット <br> import com.zc.component.stratus.ZCObject; ZCObject object = bucket.getObjectInstance("sam/out/sample.txt"); -------------------------------------------------------------------------------- title: "オブジェクトのバージョン一覧取得" description: "このページでは、オブジェクトのバージョンを取得するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.193Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/list-object-versions/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Object Versioning Help Documentation (/ja/cloud-scale/help/stratus/stratus-config/general-settings/#versioning) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/get-object-versions/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/get-object-versions/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトのバージョン一覧取得 ### オブジェクトの全バージョンの一覧取得 バケットでバージョニングを有効にすると、同じオブジェクトの複数のバージョンをバケットに保存できます。オブジェクトの各バージョンには独自のversionIdがあります。このSDKメソッドを使用すると、バケット内のオブジェクトの既存のすべてのバージョンをページネーションで取得できます。以下のコードスニペットで使用されているObject参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>nextToken</td> <td>String</td> <td>次のバージョンセットを決定するための値を保持します。</td> </tr> <tr> <td>maxVersion</td> <td>int</td> <td>任意パラメータです。各イテレーションで一覧取得できるオブジェクトのバージョンの最大数の値を保持します。</td> </tr> </tbody> </table> #### サンプルコードスニペット <br> import com.zc.component.stratus.ZCBucket; import com.zc.component.stratus.ZCStratus; import com.zc.component.stratus.ZCPagedObjectResponse; import com.zc.component.stratus.ZCObject; import com.zc.component.stratus.beans.ZCObjectVersions; import com.zc.component.stratus.beans.ZCObjectVersions.ZCVersionDetail; import java.util.List; String nextToken = null; int maxVersion = 5; do { ZCObjectVersions res = object.listPagedVersions(maxVersion, nextToken); System.out.println(res.getVersion()); for(ZCVersionDetail version : res.getVersion()) { System.out.println("version id: "+version.getVersionId()); } nextToken = res.getNextToken(); } while(nextToken != null); ### イテラブル方式でのオブジェクトの全バージョンの一覧取得 以下のSDKメソッドを使用して、オブジェクトの利用可能なすべてのバージョンを単一の呼び出しで一覧取得できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 #### サンプルコードスニペット <br> import java.util.Iterator; import com.zc.component.stratus.beans.ZCObjectVersions; import com.zc.component.stratus.beans.ZCObjectVersions.ZCVersionDetail; int maxVersion = 10; Iterable&lt;List&lt;ZCVersionDetail&gt;&gt; paginationIterable=object.listIterableVersions(maxVersion); Iterator&lt;List&lt;ZCVersionDetail&gt;&gt; iterator = paginationIterable.iterator(); while(iterator.hasNext()) { List&lt;ZCVersionDetail&gt; objects= iterator.next(); for(ZCVersionDetail object: objects){ System.out.println(object.getVersionId()); } } -------------------------------------------------------------------------------- title: "オブジェクトの詳細取得" description: "このページでは、バケットに格納されているオブジェクトの詳細を取得するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.193Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/object-details/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Objects Help Documentation (/ja/cloud-scale/help/stratus/objects/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/object-details/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/object-details/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/cloud-scale/help/stratus/introduction) - Android SDK (/ja/cloud-scale/help/stratus/introduction) - Flutter SDK (/ja/cloud-scale/help/stratus/introduction) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトの詳細取得 ### オブジェクトの詳細の取得 このSDKメソッドを使用すると、オブジェクトとそのすべてのバージョンの詳細を取得できます。以下のコードスニペットで使用されているObject参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 #### サンプルコードスニペット <br> import com.zc.component.stratus.ZCObject; ZCObject objectRes = object.getDetails(); System.out.println(objectRes); Note: バージョニングが有効な場合、このSDKメソッドを使用すると、最新バージョンのオブジェクトの詳細のみが返されます。 ### 特定バージョンのオブジェクトの詳細の取得 このSDKメソッドを使用すると、特定のオブジェクトのバージョンの詳細を取得できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>versionId</td> <td>String</td> <td>任意パラメータです。バケットでバージョニングが有効な場合、このパラメータで一意のバージョンIDを使用して特定のバージョンを参照できます。</td> </tr> </tbody> </table> #### サンプルコードスニペット <br> import com.zc.component.stratus.ZCObject; ZCObject objectRes = object.getDetails("versionId"); System.out.println(objectRes); Note: パラメータ値としてtopVersionを渡すことで、オブジェクトの最新バージョンの詳細を取得できます。 -------------------------------------------------------------------------------- title: "オブジェクトメタデータの設定" description: "このページでは、オブジェクトに格納されているオブジェクトのメタデータを追加するためのJava SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.200Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/stratus/put-object-meta/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Object Metadata Help Documentation (/ja/cloud-scale/help/stratus/objects/introduction/#metadata) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/put-object-meta/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/put-object-meta/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトメタデータの設定 以下のSDKメソッドを使用して、Stratusのバケットに格納されている特定のオブジェクトにメタ詳細を追加できます。以下のコードスニペットで使用されているObject参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 メタ詳細はJSONのキーバリューペアとして渡されます。例：{"meta_key" : "meta_value"} Note: * メタデータの記述には、英数字、アンダースコア、空白文字、およびハイフンを使用できます。上記以外の特殊文字は使用できません。 * **HEAD**リクエストメソッドを使用して、オブジェクトのメタデータを取得できます。レスポンスでは、メタデータはキー「x-user-meta」に一覧表示されます。 * メタデータ全体の最大サイズ制限は**2047**文字です。サイズ制限を決定するために使用される文字数には、キーバリューペアを定義するために使用されるコロン「:」の特殊文字も含まれます。 #### サンプルコードスニペット <br> import org.json.simple.JSONObject; import java.util.HashMap; HashMap&lt;String, String&gt; objectMeta = new HashMap&lt;&gt;(); objectMeta.put("key1", "value1"); objectMeta.put("key2", "value2"); JSONObject res = object.putMeta(objectMeta); System.out.println(res); Note: このメソッドを使用して既存の詳細を含めずに新しいメタ詳細を渡すと、既存の詳細が削除され、新しい詳細のみが設定されます。これを避けるには、既存のメタ詳細とともに新しいメタ詳細を渡してください。 **レスポンス例** { "message": "Metadata added successfully" } ##### ZCQL -------------------------------------------------------------------------------- title: "ZCQLクエリの実行" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してData Storeのテーブルに対してZCQLクエリを実行する方法について説明します。" last_updated: "2026-06-10T06:04:54.208Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/zcql/execute-zcql-query/" service: "Cloud Scale" related: - Execute ZCQL queries - API (/ja/api/code-reference/cloud-scale/zcql/execute-zcql-query/#ExecuteZCQLQuery) - Execute ZCQL queries (/ja/cloud-scale/help/zcql/introduction) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # ZCQL ZCQLは、Catalyst Data Storeのテーブルに対してデータの取得、挿入、更新、および削除操作を実行できるCatalyst独自のクエリ言語です。ZCQLを使用してさまざまなDMLクエリを実行し、データの取得や操作を行い、SQL Joinクロース、GroupByおよびOrderByステートメント、組み込みSQL関数などのさまざまなクロースやステートメントを使用できます。 ### ZCQLクエリの実行 Catalystは、分析的なデータ取得クエリに適したプライマリData Storeに加えて、**OLAPデータベース**も提供しています。プライマリData Storeではシンプルなトランザクションクエリを実行し、OLAPデータベースではZCQL関数を含む複雑な分析クエリを実行することを選択できます。 プライマリData Storeで実行するクエリには、SELECT、INSERT、UPDATE、またはDELETEステートメントを含めることができます。OLAPデータベースで実行するクエリには、直接の書き込み操作が許可されていないため、SELECTステートメントのみを含める必要があります。 以下のサンプルコードに示すように、ZCQLクエリを構築し、executeQuery()メソッドに渡して実行する必要があります。 executeQuery()メソッドは以下の3つのパラメータをサポートしています: * 構築されたクエリステートメントを含むString変数 * isV2?: ZCQL v2クエリかどうかを示すboolean値（trueまたはfalse） * isOLAP?: OLAPデータベースでクエリを実行するかどうかを示すboolean値（trueまたはfalse） executeQuery(query: string, isV2?: boolean , isOLAP?:boolean) 以下にサンプルSELECTクエリを示します。レスポンスには、SELECTクエリを使用して取得したレコード、またはその他の操作で生成されたレスポンスが含まれます。 #### サンプルコードスニペット <br> import com.zc.component.object.ZCRowObject; import com.zc.component.zcql.ZCQL; //実行するクエリを構築する String query = "SELECT * from empDetails limit 10"; //ZCQLインスタンスを取得し、クエリ文字列を使用してクエリを実行する ArrayList <ZCRowObject> rowList = ZCQL.getInstance().executeQuery(query, true , false) ##### メール -------------------------------------------------------------------------------- title: "メールの送信" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してエンドユーザーにメールを送信する方法について説明します。" last_updated: "2026-06-10T06:04:54.208Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/mail/send-email/" service: "Cloud Scale" related: - Send email - API (/ja/api/code-reference/cloud-scale/mail/send-email/#SendEmail) - Send email (/ja/cloud-scale/help/mail/introduction) -------------------------------------------------------------------------------- # Mail Catalyst Mailを使用すると、Catalystアプリケーションからエンドユーザーにメールを送信するために使用するビジネスのメールアドレスを追加できます。パブリックドメインまたは組織独自のドメインのメールアドレスを設定できます。また、Catalystの組み込みメールクライアントの代わりに、お好みの外部メールクライアントを使用してそのSMTP設定をCatalystで構成することもできます。 ### メールの送信 コンソールからドメイン、メールアドレス、およびお好みのメールクライアントのSMTP設定を構成する必要があります。ここに示すコードスニペットを使用すると、Catalystアプリケーションから指定したメールアドレスにメールを送信できます。 Catalystでは、1回のメール送信操作で複数のメールアドレスを受信者として設定し、CC、BCC、および返信先を設定できます。メールにファイルを添付することもできます。1回のメール送信操作でのメール受信者とファイル添付の最大サポート制限は以下のとおりです: * 宛先アドレス: 10 * CC: 10 * BCC: 5 * 返信先: 5 * ファイル添付数: 5 * ファイル添付サイズ: 15 MB（1つのファイルまたは最大5つの複数ファイル） 注意: 件名、送信者、および少なくとも1つの受信者メールアドレスは必須です。メールのその他の属性はオプションです。 以下のコードに示すように、ZCMailContentのインスタンスを取得する必要があります。メールの受信者とファイル添付をArrayListとして定義できます。次に、これらのリスト、送信者のメールアドレス、メールの件名と内容をZCMailContentオブジェクトに設定し、sendMail()メソッドに引数として渡してメールを送信します。 注意: メールを送信するには、Catalystコンソールで送信者のメールアドレスを構成および検証しておく必要があります。送信者のメールがプライベートドメインでホストされている場合、またはサードパーティのメールクライアントを使用する場合は、メール送信前にそれらも構成する必要があります。 #### サンプルコードスニペット import java.io.File; import com.zc.component.mail.ZCMail; import com.zc.component.mail.ZCMailContent; ZCMailContent mailContent = ZCMailContent.getInstance(); //ZCMailContentインスタンスを取得する ArrayList toMailList = new ArrayList(); //受信者のメールアドレスを配列リストとして追加する toMailList.add("vanessa.hyde@zoho.com"); toMailList.add("r.owens@zoho.com"); toMailList.add("chang.lee@zoho.com"); ArrayList ccMailList = new ArrayList<>(); //CCのメールアドレスを配列リストとして追加する ccMailList.add("p.boyle@zylker.com"); ccMailList.add("robert.plant@zylker.com"); ArrayList bccMailList = new ArrayList<>(); //BCCのメールアドレスを配列リストとして追加する bccMailList.add("ham.gunn@zylker.com"); bccMailList.add("rover.jenkins@zylker.com"); ArrayList replytoMailList = new ArrayList<>(); //返信先のメールアドレスを配列リストとして追加する replytoMailList.add("peter.d@zoho.com"); replytoMailList.add("arnold.h@zoho.com"); ArrayList attachments = new ArrayList<>(); //メールの添付ファイルを配列リストとして追加する File file1 = new File("kycform.pdf"); File file2 = new File("info.png"); attachments.add(file1); attachments.add(file2); // ZCMailContentオブジェクトにメールのプロパティを設定する mailContent.setFromEmail("p.boyle@zylker.com"); //送信者のメールアドレスを設定する mailContent.setToEmailList(toMailList); //受信者の配列リストを渡す mailContent.setCcEmailList(ccMailList); //CCの配列リストを渡す mailContent.setBccEmailList(bccMailList); //BCCの配列リストを渡す mailContent.setReplyTo(replytoMailList); //返信先の配列リストを渡す mailContent.setSubject("Greetings from Zylker Corp!"); //メールの件名を設定する mailContent.setContent("Hello,We're glad to welcome you at Zylker Corp. To begin your journey with us, please download the attached KYC form and fill in your details. You can send us the completed form to this same email address.We cannot wait to get started!Cheers!Team Zylker"); //メールの本文をHTMLコンテンツとして設定する mailContent.setAttachments(attachments); //メール添付ファイルの配列リストを渡す ZCMail.getInstance().sendMail(mailContent); //mailContentオブジェクトを使用してメールを送信する ##### キャッシュ -------------------------------------------------------------------------------- title: "セグメントインスタンスの取得" description: "このページでは、Javaアプリケーションでキャッシュセグメントインスタンスを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.209Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/cache/get-segment-instance/" service: "Cloud Scale" related: - Cache (/ja/cloud-scale/help/cache/introduction) -------------------------------------------------------------------------------- # Cache ### セグメントインスタンスの取得 キャッシュセグメントを参照するための最初のステップは、 getSegmentInstance()メソッドを使用して空のセグメントインスタンスを作成することです。このメソッドは実際にはサーバーサイドの呼び出しを行いません。この空のセグメントインスタンスには値が保持されません。 #### サンプルコードスニペット import com.zc.component.cache.ZCCache; import com.zc.component.cache.ZCSegment; //キャッシュインスタンスを取得する ZCCache cacheobj=ZCCache.getInstance(); //セグメントIDで特定のセグメントのインスタンスを取得する ZCSegment segment = cacheobj.getSegmentInstance(1510000000054091L); -------------------------------------------------------------------------------- title: "キャッシュからのデータ取得" description: "このページでは、Javaアプリケーションでキャッシュからデータを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.209Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/cache/retrieve-data-from-cache/" service: "Cloud Scale" related: - Retrieve Data from the Cache - API (/ja/api/code-reference/cloud-scale/cache/get-cache-value/#GetCacheValue) - Cache (/ja/cloud-scale/help/cache/introduction) -------------------------------------------------------------------------------- # キャッシュからのデータ取得 ### キー名による値の取得 すべてのキャッシュセグメントにはキーバリューペアが含まれています。キーと値はどちらも_String_型です。キーの値は getCacheValue()メソッドを通じて取得されます。 #### サンプルコードスニペット import com.zc.component.cache.ZCCache; import com.zc.component.cache.ZCSegment; //キャッシュインスタンスを取得する ZCCache cacheobj=ZCCache.getInstance(); //セグメントIDで特定のセグメントのインスタンスを取得する ZCSegment segment = cacheobj.getSegment(1510000000054091L); //キーを使用してキャッシュオブジェクトの値を取得する String cacheValue= segment.getCacheValue("Val"); ### キー名によるキャッシュオブジェクトの取得 キャッシュオブジェクトを取得する別のバリエーションとして、キーに対応する値をキャッシュオブジェクトとして返す方法があります。 Note: キャッシュオブジェクトには、キー、値、有効期限などのすべての属性が含まれます。 #### サンプルコードスニペット import com.zc.component.cache.ZCCache; import com.zc.component.cache.ZCCacheObject; import com.zc.component.cache.ZCSegment; //キャッシュインスタンスを取得する ZCCache cacheobj=ZCCache.getInstance(); //セグメントIDで特定のセグメントのインスタンスを取得する ZCSegment segment = cacheobj.getSegment(1510000000054091L); //ここにセグメントIDを入力してください //キーを使用してキャッシュオブジェクトを取得する ZCCacheObject cacheValue = segment.getCacheObject("Name"); // キャッシュキーを置き換えてください -------------------------------------------------------------------------------- title: "キャッシュへのデータ挿入" description: "このページでは、Javaアプリケーションでキャッシュにデータを挿入するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.209Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/cache/insert-data-into-cache/" service: "Cloud Scale" related: - Insert Data into the Cache - API (/ja/api/code-reference/cloud-scale/cache/insert-key-value-in-segment/#InsertKey-ValueinCacheSegment) - Cache (/ja/cloud-scale/help/cache/introduction) -------------------------------------------------------------------------------- # キャッシュへのデータ挿入 キャッシュ情報の取得に加えて、以下のputCache()のバリエーションはキャッシュオブジェクト要素の挿入もサポートしています。 ### キーバリューペアの挿入 以下のコードは、putCacheValue()メソッドを使用してキャッシュセグメントにキーバリューペアを挿入します。 Note: 有効期限はデフォルトで48時間に設定されています。 #### サンプルコードスニペット import com.zc.component.cache.ZCCache; import com.zc.component.cache.ZCCacheObject; import com.zc.component.cache.ZCSegment; //キャッシュインスタンスを取得する ZCCache cacheobj=ZCCache.getInstance(); //セグメントIDで特定のセグメントのインスタンスを取得する ZCSegment segment = cacheobj.getSegment(1510000000054091L); //キャッシュにキー・バリューペアとして値を保存する（デフォルトの有効期限は48時間） ZCCacheObject cache = segment.putCacheValue("Name", "Amelia Burrows"); ### 有効期限付きのキーバリューペアの挿入 前述のケースと同様に、キーと値のパラメータに加えて、オプションパラメータの有効期限がこのバリエーションで使用されます。 Note: 有効期限の値は、時間単位のlong値として渡す必要があります。 #### サンプルコードスニペット import com.zc.component.cache.ZCCache; import com.zc.component.cache.ZCCacheObject; import com.zc.component.cache.ZCSegment; //キャッシュインスタンスを取得する ZCCache cacheobj=ZCCache.getInstance(); //セグメントIDで特定のセグメントのインスタンスを取得する ZCSegment segment = cacheobj.getSegment(1510000000054091L); //指定した有効期限でキャッシュにキー・バリューペアとして値を保存する。（時間単位） ZCCacheObject cache = segment.putCacheValue("LastName", "S", 1L); ### キャッシュオブジェクトによるキーバリューペアの挿入 以下のコードは、putCacheObject()メソッドを使用してキャッシュセグメントにキーバリューペアを挿入します。 Note: キー名がキャッシュセグメントに既に存在する場合、新しく挿入された値で置き換えられます。 #### サンプルコードスニペット import com.zc.component.cache.ZCCache; import com.zc.component.cache.ZCCacheObject; import com.zc.component.cache.ZCSegment; //キャッシュインスタンスを取得する ZCCache cacheobj=ZCCache.getInstance(); //セグメントIDで特定のセグメントのインスタンスを取得する ZCSegment segment = cacheobj.getSegment(1510000000054091L); //CacheObjectを作成してキャッシュセグメントの属性を設定する ZCCacheObject cacheDetails = ZCCacheObject.getInstance(); cacheDetails.setKeyName("ObjectKey"); cacheDetails.setValue("ObjectValue"); cacheDetails.setExpiryInHours(1L); //CacheObjectを使用してキャッシュを作成する ZCCacheObject cache = segment.putCacheObject(cacheDetails); -------------------------------------------------------------------------------- title: "キャッシュデータの更新" description: "このページでは、Javaアプリケーションでキャッシュのデータを更新するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.210Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/cache/update-data-in-cache/" service: "Cloud Scale" related: - Update Data in Cache - API (/ja/api/code-reference/cloud-scale/cache/update-key-value/#UpdateKey-ValuePair) - Cache (/ja/cloud-scale/help/cache/introduction) -------------------------------------------------------------------------------- # キャッシュデータの更新 キャッシュの既存データはupdateCacheValue()メソッドを通じて更新できます。以下の2つのバリエーションがあります。 ### キーのキャッシュ値を更新する このバリエーションでは、更新した値をupdateCacheValue()メソッドのパラメータとして渡すことで、既存のキーの値を更新します。 キーの有効期限は以前の値が維持されます。 #### サンプルコードスニペット import com.zc.component.cache.ZCCache; import com.zc.component.cache.ZCSegment; //キャッシュインスタンスを取得する ZCCache cacheobj=ZCCache.getInstance(); //セグメントIDで特定のセグメントのインスタンスを取得する ZCSegment segment = cacheobj.getSegment(1510000000054091L); //ここにセグメントIDを入力してください // 既存のキャッシュのキーの値を更新する ZCCache.getInstance().updateCacheValue("time_taken", "10"); ### 有効期限付きのキャッシュ値の更新 上記と同様に、このバリエーションではキーの値を更新しますが、キーの有効期限もメソッドのパラメータとして渡します。 有効期限の値は、時間単位のlong int値として渡された新しい値で更新されます。 #### サンプルコードスニペット import com.zc.component.cache.ZCCache; import com.zc.component.cache.ZCSegment; //キャッシュインスタンスを取得する ZCCache cacheobj=ZCCache.getInstance(); //セグメントIDで特定のセグメントのインスタンスを取得する ZCSegment segment = cacheobj.getSegment(151xxxxxxxxxL); //既存のキャッシュのキーの値を有効期限と共に更新する ZCCache.getInstance().updateCacheValue("time_taken", "48", 2L); -------------------------------------------------------------------------------- title: "キーバリューペアの削除" description: "このページでは、Javaアプリケーションでキーまたはキャッシュオブジェクトを使用してキーバリューペアを削除するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.210Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/cache/delete-key-value-pair/" service: "Cloud Scale" related: - Cache (/ja/cloud-scale/help/cache/introduction) -------------------------------------------------------------------------------- # キーバリューペアの削除 キーバリューペアが不要になった場合、キャッシュセグメントから完全に削除できます。キーバリューペアは削除後に復元することはできませんが、再作成は可能です。 ### キーによる削除 キーをdeleteCacheValue()メソッドにパラメータとして直接渡すことで削除できます。 #### サンプルコードスニペット import com.zc.component.cache.ZCCache; import com.zc.component.cache.ZCSegment; //キャッシュインスタンスを取得する ZCCache cacheobj=ZCCache.getInstance(); //セグメントIDで特定のセグメントのインスタンスを取得する ZCSegment segment = cacheobj.getSegment(1510000000054091L); //キーを使用してキャッシュオブジェクトを削除する segment.deleteCacheValue("Name"); ### キャッシュオブジェクトによる削除 この削除バリエーションでは、空のキャッシュインスタンスを構築し、キー値を設定します。このインスタンスをdeleteCacheObject()メソッドの引数として渡します。 #### サンプルコードスニペット import com.zc.component.cache.ZCCache; import com.zc.component.cache.ZCCacheObject; import com.zc.component.cache.ZCSegment; //キャッシュインスタンスを取得する ZCCache cacheobj=ZCCache.getInstance(); //セグメントIDで特定のセグメントのインスタンスを取得する ZCSegment segment = cacheobj.getSegment(1510000000054091L); //CacheObjectを作成してキャッシュの詳細を設定する ZCCacheObject cacheDetails = ZCCacheObject.getInstance(); cacheDetails.setKeyName("ObjectKey"); //CacheObjectを使用してキャッシュを削除する segment.deleteCacheObject(cacheDetails); ##### コネクション -------------------------------------------------------------------------------- title: "Connectionsインスタンスの取得" description: "このページでは、Connections SDKメソッドを使用するためにConnectionsコンポーネントのインスタンスを取得するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.210Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/connections/get-connections-instance/" service: "Cloud Scale" related: - Connections Help (/ja/cloud-scale/help/connections/introduction/) - Connections Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/connections/get-connections-instance/) - Connections Python SDK (/ja/sdk/python/v1/cloud-scale/connections/get-connections-instance/) -------------------------------------------------------------------------------- # Connections Connectionsを使用すると、すべての認証トークン要件を管理しながら、Zohoやその他のサードパーティサービスと統合できます。 ### Connectionsインスタンスの取得 Note: このSDKは、FunctionsやAppSailなどのCatalystサービス内でのみアクセスできます。サードパーティサービスとの統合には使用できません。 以下に示すようにconnectionsコンポーネントの参照を取得できます。これはサーバーサイドの呼び出しを行いません。このコンポーネントインスタンスは、Connectionsを使用する各種コードスニペットで参照します。 **Package Import** import com.zc.component.connections.ZCConnections; import com.zc.component.connections.beans.ZCConnectionResponse; // 接続インスタンスを作成する ZCConnections connections = ZCConnections.getInstance(); -------------------------------------------------------------------------------- title: "認証資格情報の取得" description: "このページでは、必要な認証資格情報を取得するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.210Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/connections/get-credentials/" service: "Cloud Scale" related: - Connections Help (/ja/cloud-scale/help/connections/introduction/) - Connections Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/connections/get-credentials/) - Connections Python SDK (/ja/sdk/python/v1/cloud-scale/connections/get-credentials/) -------------------------------------------------------------------------------- # 認証資格情報の取得 Note: このSDKは、FunctionsやAppSailなどのCatalystサービス内でのみアクセスできます。サードパーティサービスとの統合には使用できません。 このSDKメソッドを使用して、デフォルトサービスとしてリストされている各種Zohoサービスの認証資格情報を取得できます。 以下のコードスニペットで使用されているconnections参照は、コンポーネントインスタンスです。 import com.zc.component.connections.ZCConnections; import com.zc.component.connections.beans.ZCConnectionResponse; // 接続インスタンスを作成する ZCConnections connections = ZCConnections.getInstance(); // 指定された接続の認証資格情報を取得する ZCConnectionResponse connectionResponse = connections.getConnectionCredentials("payrollcon"); // 接続レスポンス System.out.println("Connection Response Headers: " + connectionResponse.getHeaders()); System.out.println("Connection Response Parameters: " + connectionResponse.getParameters()); ##### プッシュ通知 -------------------------------------------------------------------------------- title: "Webアプリへのプッシュ通知の送信" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してエンドユーザーにリモート通知を送信する方法について説明します。" last_updated: "2026-06-10T06:04:54.211Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/push-notifications/send-notifications/" service: "Cloud Scale" related: - Send push notifications - API (/ja/api/code-reference/cloud-scale/push-notifications/web/send-web-push-notifications/#SendWebNotifications) - Send push notifications (/ja/cloud-scale/help/push-notifications/introduction) -------------------------------------------------------------------------------- # Push Notifications Catalyst Push Notificationsを使用すると、アプリがユーザーのデバイスでアクティブに実行されていない場合でも、アプリケーションのユーザーにリモート通知を送信できます。特定のターゲットユーザーリストにプッシュ通知を送信できます。アラート、アップデート、またはプロモーションコンテンツを含めて、ユーザーがアプリケーションに関与するようにできます。 プッシュ通知を送信する前に、ユーザーが許可した際にWebアプリでプッシュ通知を有効にする必要があります。これは、Webクライアントにこのコードスニペットを実装することで行えます。このコードは、Catalystリモートコンソールの_Push Notifications_セクションからもアクセスできます。Web初期化スクリプトを含めることを確認してください。 ### Webアプリへのプッシュ通知の送信 Catalystでは、1回の関数呼び出しで50人のユーザーにプッシュ通知を送信できます。以下に示すように、通知する全ユーザーのユーザーIDを配列に追加できます。次に、通知に含めるメッセージ文字列と共に、配列をnotifyUser()メソッドに渡す必要があります。この文字列はプレーンテキスト、HTML、またはパースされるJSONオブジェクトにすることができます。 #### サンプルコードスニペット import com.zc.component.notifications.ZCWebNotification; Long[] userList = new Long[5]; //すべてのユーザーのユーザーIDを含める userList[0] = 1234556789098L; userList[1] = 8704590865890L; userList[2] = 1452788189992L; userList[3] = 5344535567809L; userList[4] = 6568785589800L; ZCWebNotification.getInstance().notifyUser("Hi there! The task you scheduled has been completed.", userList); //メッセージ文字列を含む配列を渡す ユーザーIDの代わりにメールアドレスを含めて、ユーザーに通知を送信することもできます。メールアドレスをString配列に追加し、同様の方法でメッセージ文字列と共にnotifyUser()に渡す必要があります。 #### サンプルコードスニペット import com.zc.component.notifications.ZCWebNotification; String[] userEmailList = new String[3]; //ユーザーのメールアドレスを含める userEmailList[0] = "emma@zylker.com"; userEmailList[1] = "p.boyle@zylker.com"; userEmailList[2] = "noel@zylker.com"; ZCWebNotification.getInstance().notifyUser("Hi there! The task you scheduled has been completed.", userEmailList); //メッセージ文字列を含む配列を渡す -------------------------------------------------------------------------------- title: "モバイルアプリへのプッシュ通知の送信" description: "このページでは、サンプルコードスニペットを使用してAndroidまたはiOSアプリケーションのエンドユーザーにリモート通知を送信する方法について説明します。" last_updated: "2026-06-10T06:04:54.211Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/push-notifications/send-notifications-mobile/" service: "Cloud Scale" related: - Push Notifications (/ja/cloud-scale/help/push-notifications/introduction) -------------------------------------------------------------------------------- # モバイルアプリへのプッシュ通知 Catalyst Cloud Scale Push Notificationsコンポーネントを使用すると、AndroidまたはiOSプラットフォーム上に構築されたモバイルアプリケーションに通知を送信できます。CatalystユーザーIDまたはメールアドレスを使用して、特定のターゲットユーザーにプッシュ通知を送信できます。アラート、アップデート、またはプロモーションコンテンツを含めて、ユーザーがアプリケーションに関与するようにできます。 プッシュ通知を設定するには、以下の前提条件を満たす必要があります: 1. モバイルアプリケーションをCatalystに登録し、設定後にコンソールからアプリケーションID（appId）を記録する必要があります。ターゲットデバイスにインストールされたアプリケーションの登録には、個別のプラットフォーム固有のCatalyst Mobile SDKメソッド（AndroidおよびiOSで利用可能）またはFlutter SDKを使用できます。 appIdは、Catalystコンソールで直接Android Push Notificationsサービスを設定することで取得できます。 Android SDKを使用したAndroidアプリの登録について学ぶ。 iOS SDKを使用したiOSアプリの登録について学ぶ。 Flutter SDKを使用したモバイルアプリ（AndroidまたはiOS）の登録について学ぶ。 2. モバイルアプリケーションは、Catalyst Cloud Scale Authenticationコンポーネントを必ず使用する必要があります。 すべての設定が完了した後、Catalystユーザーは通知を迅速に受信するためにデバイスにログインしている必要があります。 設定が完了したら、生成されたアプリケーションIDを使用して特定のアプリをターゲットにし、以下のJava SDKメソッドを呼び出して通知を送信できます。 <br> ### モバイル通知インスタンスの取得 モバイル通知インスタンスを作成し、Catalystコンソールに登録された特定のモバイルアプリを参照するために使用できます。これは、生成されたappIDをパラメータとして渡し、getInstance()メソッドでモバイル通知インスタンスを取得することで行います。 このモバイル通知インスタンスを使用して、次のセクションで説明するプッシュ通知の送信など、Java SDKメソッドで追加の操作を実行します。 #### サンプルコードスニペット import com.zc.component.notifications.ZCMobileNotification; ZCMobileNotification mobile = ZCMobileNotification.getInstance(1234567890l); ここで、1234567890はappIDです。また、アプリケーションがCatalystスコープベースのアクセスを使用している場合は、appIDと共にZCProject projectパラメータを渡すこともできます。 ZCMobileNotification mobile = ZCMobileNotification.getInstance(1234567890l, ZCProject project); <br> ### Androidプッシュ通知の送信 プッシュ通知送信のためにCatalystにAndroidアプリケーションを登録した後、sendAndroidPushNotification()メソッドを使用してアプリケーションにプッシュ通知を送信できます。 sendAndroidPushNotification()メソッドに2つのパラメータを渡す必要があります: * pushMessage - プッシュ通知メッセージの詳細を含むZCPush型オブジェクト。 * recipient - メッセージを配信する受信者のCatalystユーザーIDまたはメールアドレス。 #### サンプルコードスニペット import com.zc.component.notifications.ZCMobileNotification; import com.zc.component.notifications.ZCPush; import com.zc.component.notifications.ZCPushMessage; ZCPushMessage notificationRes = mobile.sendAndroidPushNotification(new ZCPush() { { setMessage("This message is to test if the functionality is working fine!"); setBadgeCount(1); } }, "emma.b@zylker.com"); setBadgeCount()は、アプリアイコンの通知バッジカウントを1に設定します。この値は必要に応じて任意の数値に変更できます。 <br> ### iOSプッシュ通知の送信 Androidと同様に、プッシュ通知送信のためにCatalystにiOSアプリケーションを登録した後、sendIOSPushNotification()メソッドを使用してアプリケーションにプッシュ通知を送信できます。 #### サンプルコードスニペット import com.zc.component.notifications.ZCMobileNotification; import com.zc.component.notifications.ZCPush; import com.zc.component.notifications.ZCPushMessage; ZCPushMessage notificationRes = mobile.sendIOSPushNotification(new ZCPush() { { setMessage("This message is to test if the functionality is working fine!"); setBadgeCount(1); } }, "emma.b@zylker.com"); ##### 検索 -------------------------------------------------------------------------------- title: "テーブル内のデータ検索" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用して複数のテーブル内のデータを検索する方法について説明します。" last_updated: "2026-06-10T06:04:54.211Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/search/search-data/" service: "Cloud Scale" related: - Search data in tables - API (/ja/api/code-reference/cloud-scale/search/execute-search-query/#ExecuteSearchQuery) -------------------------------------------------------------------------------- # インデックス付きカラムのデータ検索 Searchは、特定のデータパターンを検索するためにsearchQuery()メソッドを実行します。以下を検索できます: * 複数のテーブルのデータ * 検索インデックス付きカラムのデータのみ 検索の詳細については、こちらのドキュメントを参照してください。 以下のコードスニペットには、テーブルの指定されたカラムで検索するパターンが含まれています: #### サンプルコードスニペット import com.zc.component.object.ZCRowObject; import com.zc.component.search.ZCSearch; import com.zc.component.search.ZCSearchDetails; //SearchDetailsのインスタンスを取得する ZCSearchDetails search = ZCSearchDetails.getInstance(); //検索するパターンを設定する search.setSearch("Sa*"); //テーブルと対応する列リストのハッシュマップを作成して検索する HashMap&lt;String,List\*&gt; map = new HashMap <String,List\>(); List searchList1 = new ArrayList(); List searchList2 = new ArrayList(); //同じまたは異なるテーブルのインデックス付き列をリストに追加する searchList1.add("SearchIndexedColumn"); searchList2.add("SearchTest"); //テーブルとその名前および列リストを追加する map.put("SampleTable", searchList1); map.put("Users", searchList2); //検索用のテーブル-列マッピングを設定する search.setSearchTableColumns(map); //詳細を含む検索インスタンスを渡して検索を実行する ArrayList&lt;ZCRowObject&gt; rowList = ZCSearch.getInstance().executeSearchQuery(search); ##### 認証 -------------------------------------------------------------------------------- title: "新規ユーザーの追加" description: "このページでは、Catalyst Authenticationを使用してJavaアプリケーションに新しいエンドユーザーを追加するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.214Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/authentication/add-new-user/" service: "Cloud Scale" related: - Add new user - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) - Catalyst Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # Authentication Catalyst Authenticationの機能を使用すると、Catalystサーバーレスアプリケーションにエンドユーザーを追加し、ユーザーアカウントとロールを設定し、アプリケーションのユーザーサインインと認証を管理できます。リモートコンソールからのCatalyst Authenticationの使用方法については、 Authenticationヘルプドキュメントを参照してください。 ### 新規ユーザーの追加 ユーザーがCatalystアプリケーションにサインアップすると、ZUIDや userIDなどの一意の識別値が作成されます。また、Catalystによってユーザーは組織に割り当てられます。詳細については、ユーザーヘルプ ページを参照してください。 以下のコードを使用して、Catalystアプリケーションに新しいエンドユーザーを追加できます。メールアドレス、姓、アプリケーションプラットフォーム、割り当てるロールなどのユーザー詳細は、 ZCSignUpDataクラスのインスタンスを通じて渡されます。ユーザー登録プロセスは、ZCUserクラスのインスタンスを取得した後、 registerUser()メソッドによって処理されます。 Note: * 開発環境では、アプリケーションに追加できるユーザーは25人までです。アプリケーションを本番環境にデプロイした後は、任意の数のエンドユーザーを含めることができます。 * ユーザーを登録するには、EmailIdとFirstNameの値を必ず指定する必要があります。 * RoleIdは、Catalystコンソールの_Authentication_内の_Roles_セクションから取得できます。 * 新しいユーザーを招待する際、送信者のメールアドレス、件名、メールメッセージを設定できます。Catalyst Mailコンポーネントにメールアドレスを追加し、SDKコードで使用する前に認証を完了させる必要があります。 #### サンプルコードスニペット <br> import com.zc.component.users.PlatformType; import com.zc.component.users.ZCSignUpData; import com.zc.component.users.ZCUser; import com.zc.component.ZCMailTemplateDetails; //ZCSignUpDataのインスタンスを取得する ZCSignUpData signUpdetails = ZCSignUpData.getInstance(); //インスタンスを使用してサインアップに必要なデータを渡す ZCMailTemplateDetails mailData= signUpdetails.mailTemplateInstance(); mailData.setSendersMail("docofoh552@lukaat.com"); mailData.setSubject("Welcome to %APP_NAME%"); mailData.setMessage("<p>Hello ,</p> <p>Follow this link to join in %APP_NAME% .</p> <p><a href='\%LINK%\'>%LINK%</a></p> <p>If you didn't ask to join the application, you can ignore this email.</p> <p>Thanks,</p> <p>Your %APP_NAME% team</p>"); signUpdetails.setTemplateDetails(mailData); signUpdetails.setPlatformType(PlatformType.WEB); signUpdetails.userDetail.setEmailId("p.boyle@zylker.com"); signUpdetails.userDetail.setLastName("Boyle"); signUpdetails.userDetail.setRoleId(1256000000228024L); //ZCUserクラスのインスタンスを使用してユーザーを登録する signUpdetails = ZCUser.getInstance().registerUser(signUpdetails); -------------------------------------------------------------------------------- title: "すべてのOrg IDの取得" description: "このページでは、Catalyst Authenticationを使用してJavaアプリケーションに関連付けられたすべてのOrg IDを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.214Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/authentication/get-org-id/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - User Management (/ja/cloud-scale/help/authentication/user-management/users/introduction/) -------------------------------------------------------------------------------- # すべてのOrg IDの取得 Org IDまたはZAAIDは、エンドユーザーが所属する組織の一意の識別子です。この識別子は、エンドユーザーがいずれかの認証タイプを通じてアプリケーションにサインアップした時、Add User APIを通じて追加された時、またはコンソールのAdd Userボタンを通じて追加された時に生成されます。 以下のSDKスニペットは、getAllOrgs()メソッドを使用して、アプリケーションに新しいユーザーを追加する際に生成されたすべてのOrg IDを取得する方法を示しています。 #### サンプルコードスニペット <br> import com.zc.component.users.ZCUser; ZCUser user = ZCUser.getInstance(); user.getAllOrgs(); <br /> -------------------------------------------------------------------------------- title: "既存組織へのユーザー追加" description: "このページでは、Catalyst Authenticationを使用してJavaアプリケーションに新しいエンドユーザーを追加するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.214Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/authentication/add-new-user-to-existing-org/" service: "Cloud Scale" related: - Add New User to Existing Org - API (/ja/api/code-reference/cloud-scale/authentication/add-user-to-existing-org/#AddaNewUsertoanExistingOrganization) - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # 既存組織への新規ユーザーの追加 以下のコードスニペットを使用すると、新しい組織を作成せずに、既存の組織にユーザーを登録できます。 Note: * FirstName、EmailId、OrgIDは必須属性です。 * 新しいユーザーを招待する際、送信者のメールアドレス、件名、メールメッセージを設定できます。Catalyst Mailコンポーネントにメールアドレスを追加し、SDKコードで使用する前に認証を完了させる必要があります。 #### サンプルコードスニペット <br> import com.zc.component.users.PlatformType; import com.zc.component.users.ZCSignUpData; import com.zc.component.users.ZCUser; import com.zc.component.ZCMailTemplateDetails; //ZCSignUpDataのインスタンスを取得する ZCSignUpData signUpdetails = ZCSignUpData.getInstance(); //インスタンスを使用してサインアップに必要なデータを渡す ZCMailTemplateDetails mailData= signUpdetails.mailTemplateInstance(); mailData.setSendersMail("docofoh552@lukaat.com"); mailData.setSubject("Welcome to %APP_NAME%"); mailData.setMessage("<p>Hello ,</p> <p>Follow this link to join in %APP_NAME% .</p> <p><a href='\%LINK%\'>%LINK%</a></p> <p>If you didn't ask to join the application, you can ignore this email.</p> <p>Thanks,</p> <p>Your %APP_NAME% team</p>"); signUpdetails.setTemplateDetails(mailData); signUpdetails.setPlatformType(PlatformType.WEB); signUpdetails.userDetail.setEmailId("amelia.burrows@zylker.com"); signUpdetails.userDetail.setLastName("Amelia"); signUpdetails.userDetail.setOrgId("35712181"); //ここにユーザーの組織IDを渡す //signUpdetailsを使用してユーザーを登録する signUpdetails = ZCUser.getInstance().addUser(signUpdetails); -------------------------------------------------------------------------------- title: "組織内のすべてのユーザーの取得" description: "このページでは、Catalyst Authenticationを使用してJavaアプリケーションで組織に関連付けられたすべてのユーザーを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.214Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/authentication/get-users-in-org/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - User Management (/ja/cloud-scale/help/authentication/user-management/users/introduction/) -------------------------------------------------------------------------------- # 組織内のすべてのユーザーの取得 以下のSDKスニペットは、getAllUsers()メソッドを使用して、組織のすべてのユーザーのリストを取得する方法を示しています。 #### サンプルコードスニペット <br> import com.zc.component.users.ZCUser; ZCUser user = ZCUser.getInstance(); user.getAllUser(10062701096); // ここにOrg IDを入力してください -------------------------------------------------------------------------------- title: "パスワードのリセット" description: "このページでは、Catalyst Authenticationを使用してJavaアプリケーションに新しいエンドユーザーを追加するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.214Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/authentication/reset-password/" service: "Cloud Scale" related: - Reset Password - API (/ja/api/code-reference/cloud-scale/authentication/reset-user-password/#ResetUserPassword) - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # パスワードのリセット ユーザーの登録が正常に完了した後、以下のコードスニペットを使用してパスワードをリセットできます。呼び出されると、resetPassword()メソッドはパスワードリセットリンクを生成し、ユーザーのメールアドレスに送信します。 Note: 送信者のメールアドレス、件名、メールメッセージを設定できます。Catalyst Mailコンポーネントにメールアドレスを追加し、SDKコードで使用する前に認証を完了させる必要があります。 #### サンプルコードスニペット <br> import com.zc.component.users.PlatformType; import com.zc.component.users.ZCSignUpData; import com.zc.component.users.ZCUser; import com.zc.component.ZCMailTemplateDetails; //ZCSignUpDataのインスタンスを取得する ZCSignUpData signUpdetails = ZCSignUpData.getInstance(); //インスタンスを使用してサインアップに必要なデータを渡す ZCMailTemplateDetails mailData= signUpdetails.mailTemplateInstance(); mailData.setSendersMail("docofoh552@lukaat.com"); mailData.setSubject("Welcome to %APP_NAME%"); mailData.setMessage("<p>Hello ,</p> <p>Follow this link to join in %APP_NAME% .</p> <p><a href='\%LINK%\'>%LINK%</a></p> <p>If you didn't ask to join the application, you can ignore this email.</p> <p>Thanks,</p> <p>Your %APP_NAME% team</p>"); signUpdetails.setTemplateDetails(mailData); signUpdetails.setPlatformType(PlatformType.WEB); signUpdetails.userDetail.setEmailId("amelia.burrows@zylker.com"); signUpdetails.userDetail.setLastName("Burrows"); //パスワードリセットメールを送信するためにreset passwordを呼び出す ZCUser.getInstance().resetPassword(signUpdetails); -------------------------------------------------------------------------------- title: "カスタムサーバートークンの生成" description: "このページでは、Catalyst Authenticationを使用してJavaアプリケーションに新しいエンドユーザーを追加するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.215Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/authentication/third-party-server-token/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # カスタムサーバートークンの生成 Cloud ScaleのAuthenticationコンポーネントでは、Catalystアプリケーションにサードパーティ認証サービスを実装できます。エンドユーザーの認可と検証はサードパーティサービスによって処理され、データはCatalystに渡されます。 Note: * サードパーティ認証サービスを実装しているため、アプリケーションのセキュリティインフラストラクチャは選択したサードパーティサービスの効率性に依存することをご理解ください。 * Catalystアプリケーションでサードパーティ認証を有効にするには、コンソールでPublic Signupを有効にしていることを確認してください。 ユーザーがサードパーティサービスで認証された後にリダイレクトされた場合、そのユーザーの認証情報をコーディングした認証関数に渡す必要があります。この関数には、カスタムサーバートークンを生成するCatalystサーバーサイドロジックを含める必要があり、生成されたトークンはクライアントコードに組み込まれたWeb SDKに渡されます。 カスタムサーバートークンを生成するサンプルコードを以下に示します。 #### サンプルコードスニペット ZCCustomTokenDetails customTokenDetails = ZCCustomTokenDetails.getInstance(); ZCCustomTokenUserDetails tokenUserDetails = ZCCustomTokenUserDetails.getInstance(); //トークンのユーザー詳細を設定する tokenUserDetails.setEmailId("emma@zylker.com"); tokenUserDetails.setFirstName("Amelia"); tokenUserDetails.setLastName("Burrows"); tokenUserDetails.setRoleName("App Admin"); customTokenDetails.setUserDetails(tokenUserDetails); ZCCustomTokenResponse customTokenResp = ZCUser.getInstance().generateCustomToken(customTokenDetails); このトークンは、Web SDKヘルプページで説明されているように、クライアントロジックに渡すことができます。 Note: カスタムサーバートークンは、ユーザーがサードパーティ認証サービスを使用してアプリケーションにログインするたびに生成する必要があります。 -------------------------------------------------------------------------------- title: "カスタムユーザーバリデーション" description: "このページでは、Catalyst Authenticationを使用してJavaアプリケーションに新しいエンドユーザーを追加するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.215Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/authentication/custom-user-validation/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # Custom User Validation Catalyst Authenticationでは、Catalystアプリケーションへのサインアップ時に、カスタムのBasic I/O関数を使用してエンドユーザーを認可・検証できます。この関数を通じて、ユーザーが提供する認証情報を独自のロジックで処理し、アプリケーションへのアクセスを許可できます。 Custom User Validation関数のサンプルコードを以下に示します。 #### サンプルコードスニペット <br> import com.catalyst.Context; import com.catalyst.basic.BasicIO; import com.catalyst.basic.ZCFunction; import com.zc.api.APIConstants.ZCSignupValidationStatus; import com.zc.common.ZCProject; import com.zc.component.auth.ZCSignupResponseUserDetails; import com.zc.component.auth.ZCSignupUserValidationRequest; import com.zc.component.auth.ZCSignupUserValidationResponse; import com.zc.component.users.ZCSignupUserService; バリデーションロジックはお好みに応じて設定できます。この例では、@notallowedemailを使用したロジックを示しています。ユーザーが許可されていないメールアドレスでサインアップしようとした場合、サインアップは許可されません。 public class MainClass implements ZCFunction { private static final Logger LOGGER = Logger.getLogger(MainClass.class.getName()); @Override public void runner(Context context, BasicIO basicIO) throws Exception { try { ZCProject.initProject(); ZCSignupUserValidationRequest requestDetails = ZCSignupUserService.getSignupValidationRequest(basicIO); if(requestDetails != null) { /* Validation logic starts */ LOGGER.info("Inside null check"); ZCSignupUserValidationResponse validationResponse = ZCSignupUserValidationResponse.getInstance(); if(requestDetails.getUserDetails().getEmailId().contains("@notallowedmail")) { validationResponse.setStatus(ZCSignupValidationStatus.FAILURE); // ユーザーの認証が失敗した } else { validationResponse.setStatus(ZCSignupValidationStatus.SUCCESS); // 認証成功時に発生するアクションはカスタマイズ可能 ZCSignupResponseUserDetails respUserDetails = ZCSignupResponseUserDetails.getInstance(); respUserDetails.setFirstName("Patricial"); respUserDetails.setLastName("Boyle"); respUserDetails.setRoleIdentifier("App User"); respUserDetails.setOrgId("1241113"); validationResponse.setUserDetails(respUserDetails); } basicIO.write(validationResponse); /* Validation logic ends */ } } catch(Exception e) { basicIO.write(e); LOGGER.log(Level.SEVERE,"Exception in MainClass",e); basicIO.setStatus(500); } } } <br> この関数をテストするには、以下の.JSON形式でユーザーの詳細を渡します： { "request_type": "add_user", "request_details": { "user_details": { "email_id": "emmy@zylker.com", "first_name": "Emma", "last_name": "Thompson", "org_id": "65**************", "role_details": { "role_name": "Moderator", "role_id": "10*****" } }, "auth_type": "web" } } -------------------------------------------------------------------------------- title: "ユーザー詳細の取得" description: "このページでは、Catalyst Authenticationを使用してJavaアプリケーションに新しいエンドユーザーを追加するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.215Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/authentication/get-user-details/" service: "Cloud Scale" related: - Get User Details - API (/ja/api/code-reference/cloud-scale/authentication/get-current-user/#GetCurrentUser) - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # ユーザー詳細の取得 Catalyst Authenticationには、アプリユーザーの詳細を取得するためのいくつかのバリエーションがあります。現在のユーザー、特定のユーザー、またはアプリケーションのすべてのユーザーの情報を取得できます。 ### 現在のユーザー詳細の取得 このコードは、関数が実行されているスコープのユーザーの詳細を取得します。 #### サンプルコードスニペット <br> import com.zc.component.ZCUserDetail; import com.zc.component.users.ZCUser; //現在のユーザー情報を取得するためZCUserオブジェクトのインスタンスを作成する ZCUserDetail details = ZCUser.getInstance().getCurrentUser(); ### すべてのユーザー詳細の取得 このコードは、アプリケーションに登録されているすべてのユーザーの詳細を取得できます。 #### サンプルコードスニペット <br> import com.zc.component.ZCUserDetail; import com.zc.component.users.ZCUser; //ZCUserのインスタンスを作成してgetAllUserを呼び出し、アプリ内のすべてのユーザーを取得する List&lt;ZCUserDetail&gt; details = ZCUser.getInstance().getAllUser(); ### User IDによるユーザー詳細の取得 前述のコードとは異なり、特定のユーザーの情報を取得したい場合は、このコードを使用できます。ユーザーのUser IDをgetUser()メソッドのパラメータとして渡します。 #### サンプルコードスニペット <br> import com.zc.component.ZCUserDetail; import com.zc.component.users.ZCUser; //ZCUserオブジェクトのインスタンスを作成してユーザーIDに基づくユーザー情報を取得する ZCUserDetail details = ZCUser.getInstance().getUser(1510000000113214L); -------------------------------------------------------------------------------- title: "ユーザー詳細の更新" description: "このページでは、Catalyst Authenticationを使用してJavaアプリケーションにサインアップしたユーザーの詳細を変更または更新するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.215Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/authentication/update-user-details/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Modify a User's Details in the Console (/ja/cloud-scale/help/authentication/user-management/users/implementation/#modify-a-users-details) -------------------------------------------------------------------------------- # ユーザー詳細の更新 Catalystでは、エンドユーザーの以下の詳細を変更・更新できます： * First Name * Last name * **ZAAID**: **ZAAID**またはOrg IDは、組織に関連付けるためにCatalystが生成する一意の値です。 * RoleID: Role IDは、特定のユーザーロールに割り当てるためにCatalystが生成する値です。 以下のSDKスニペットは、updateUser()メソッドを使用してエンドユーザーの詳細を更新する方法を示しています。以下の例では、ユーザーのFirst Nameが更新されます。 getUserID()メソッドはユーザーのUser IDを取得します。UserIDはAuthenticationコンポーネントの*Users* > *User Management*セクションに表示されます。 #### サンプルコードスニペット <br> import com.zc.component.ZCUserDetail; import com.zc.component.users.ZCUser; ZCUser user = ZCUser.getInstance(); ZCUserDetail userDetail = user.getCurrentUser(); userDetail.setFirstName("Josh"); user.updateUser(userDetail.getUserId(), userDetail); <br /> -------------------------------------------------------------------------------- title: "ユーザーの有効化または無効化" description: "このページでは、Catalyst Authenticationを使用してJavaアプリケーションでユーザーを有効化または無効化するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.215Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/authentication/enable-disable-user/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Enable or Disable a User in the Console (/ja/cloud-scale/help/authentication/user-management/users/implementation/#enable-or-disable-a-user) -------------------------------------------------------------------------------- # ユーザーの有効化または無効化 Catalystでは、いつでもユーザーを無効化または有効化できます。無効化されたユーザーはプロジェクトの*Users*セクションに引き続きリストされますが、アプリケーションにアクセスすることはできません。 以下のSDKスニペットは、updateUserStatus()メソッドを使用してエンドユーザーを有効化および無効化する方法を示しています。ユーザーは一意のUser IDで参照されます。すべてのユーザーのUser IDは、Authenticationコンポーネントの*Users* > *User Management*セクションに移動して確認できます。 ### ユーザーを有効化する #### サンプルコードスニペット <br> import com.zc.component.ZCUserDetail; import com.zc.component.users.ZCUser; ZCUser user = ZCUser.getInstance(); user.updateUserStatus(USER_ID, USER_STATUS.ENABLE); ### ユーザーを無効化する #### サンプルコードスニペット <br> import com.zc.component.ZCUserDetail; import com.zc.component.users.ZCUser; ZCUser user = ZCUser.getInstance(); user.updateUserStatus(USER_ID, USER_STATUS.DISABLE); <br /> -------------------------------------------------------------------------------- title: "ユーザーの削除" description: "このページでは、Javaアプリケーションからユーザーを削除するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.215Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/cloud-scale/authentication/delete-user/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # ユーザーの削除 Catalystアプリケーションのエンドユーザーを削除して、アプリケーションへのアクセスを永久に無効にできます。 これはdeleteUser()メソッドを使用して行います。以下に示すように、このメソッドのパラメータとしてユーザーの UserIDを渡す必要があります。 #### サンプルコードスニペット <br> import com.zc.component.users.ZCUser; ZCUser.getInstance().deleteUser(1510000000109587l); //削除するユーザーのユーザーIDを渡す #### Connectors -------------------------------------------------------------------------------- title: "コネクタ" description: "このページでは、Javaアプリケーションでコネクタを使用してアクセストークンを管理する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.222Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/connectors/connectors/" service: "All Services" -------------------------------------------------------------------------------- # Connectors Catalyst Connectorは、**Zoho OAuth認証**を通じて確立されたCatalystと外部Zohoサービス間のシームレスな接続を提供します。ビジネスロジックにZoho CRMやZoho WorkDrive APIなどの外部ZohoサービスのAPIの使用が含まれる場合、Catalystアプリケーションでコネクタを利用できます。 Catalystは、Zoho APIコンソールで特定のアプリケーション用に生成したアクセストークンをCatalyst Cacheに有効期限まで保存することで接続を処理します。有効期限が切れると、コネクタはリフレッシュトークンを使用して自動的に新しいアクセストークンを取得し、キャッシュに保存します。アクセストークンが期限切れになるたびに、コネクタはバックグラウンドで自動的に新しいトークンを取得してキャッシュするため、アプリケーションのビジネスロジック内で外部Zohoサービスとの中断のない接続を維持するロジックを構築する手間が省けます。 Note: Catalyst Connectorは外部Zohoサービスとの接続維持にのみ使用でき、サードパーティサービスには使用できません。これは、すべてのZohoサービスで維持されるOAuth標準が統一されており、CatalystがConnectors機能を実装するのに互換性があるためです。 以下に示すようにJavaビジネスロジックでコネクタを設定する前に、Zoho APIコンソールで新しいクライアントを登録し、手順に従って初回の認証コードとアクセストークンを生成する必要があります。その後、受け取ったリフレッシュトークンと、Client ID、Client Secret、認証URL、リフレッシュURLなどの標準的なOAuthパラメータを使用してコネクタを設定し、アクセストークンを定期的に自動更新できます。また、要件に基づいて独自のロジックをコネクタに組み込むこともできます。 Note: * ロジック内の各コネクタに指定する名前は一意である必要があります。 * Zoho APIコンソールでサーバーベースのアプリケーションを作成し、同じアプリケーション内の異なるユーザーにアクセストークンの作成を許可する場合は、各ユーザーに異なる一意のコネクタ名を指定する必要があります。これは、同じコネクタが異なるユーザーに使用されると、同じキャッシュセグメントでトークンが上書きされ、外部Zohoサービスから誤ったユーザーのデータを取得する結果になるためです。 以下のコードはJavaコネクタを示しています。 #### サンプルコードスニペット <br> import org.json.simple.JSONObject; import com.zc.auth.connectors.ZCConnection; import com.zc.auth.connectors.ZCConnector; JSONObject authJson = new JSONObject(); // JSONオブジェクトにはclient_id、client_secret、refresh_token、refresh_urlが含まれる authJson.put("client_id","{client_id}"); authJson.put("client_secret","{client_secret}"); authJson.put("auth_url","{auth_url}"); authJson.put("refresh_url","{refresh_url}"); authJson.put("refresh_in","{refresh_in}"); //リフレッシュトークンが提供されていない場合は、リフレッシュトークンを生成するコードを提供する必要がある authJson.put("refresh_token","{refresh_token}"); JSONObject connectorJson = new JSONObject(); connectorJson.put("CRMConnector",authJson); // 複数のZohoサービス用のコネクタを作成できる ZCConnection conn = ZCConnection.getInstance(connectorJson); ZCConnector crmConnector = conn.getConnector("CRMConnector"); // AccessTokenを取得する String accessToken = crmConnector.getAccessToken(); #### Job Scheduling -------------------------------------------------------------------------------- title: "概要" description: "このページでは、Job Scheduling操作を実行するためのメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.224Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/overview/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/overview/) - Python SDK (/ja/sdk/python/v1/job-scheduling/overview/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # Job Scheduling SDK Job Schedulingは、ジョブの送信をスケジュールし、Job Poolで実行してCircuits、Webhook（任意のサードパーティURL）、Job Functions、およびApp SailサービスのエンドポイントをトリガーできるCatalystサービスです。 Catalyst SDKを使用して、コードで以下の操作を実行できます： <table class="content-table"> <thead> <tr> <th class="w25p">Job Schedulingコンポーネント</th> <th class="w75p">SDKで可能な操作</th> </tr> </thead> <tbody> <tr> <td>Job Pool</td> <td>すべてのJob Poolを取得<br />特定のJob Poolを取得</td> </tr> <tr> <td>Job</td> <td>ジョブの作成<br />ジョブ詳細の取得<br />ジョブの削除</td> </tr> <tr> <td>Cron</td> <td>ワンタイムCronの作成<br />定期Cronの作成<br />Cron式を使用したCronの作成<br />特定のCronの詳細を取得<br />すべてのCronの詳細を取得<br />Cronの更新<br />Cronの一時停止<br />Cronの再開<br />Cronの実行<br />Cronの削除</td> </tr> </tbody> </table> <br /> -------------------------------------------------------------------------------- title: "Job Schedulingインスタンスの初期化" description: "このページでは、Job Schedulingサービスのコンポーネント参照を作成するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.225Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/initialize-job-scheduling-instance/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/initialize-job-scheduling-instance/) - Python SDK (/ja/sdk/python/v1/job-scheduling/initialize-job-scheduling-instance/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # Job Schedulingインスタンスの初期化 以下に示すように、Job Schedulingコンポーネント参照を作成できます。これはサーバーサイドの呼び出しを発行しません。このコンポーネントインスタンスは、Job Schedulingのコンポーネントを操作する様々なコードスニペットで参照します。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.ZCJobScheduling; ZCJobScheduling jobScheduling = ZCJobScheduling.getInstance(); // ジョブスケジューリングインスタンスを取得する ##### Cron -------------------------------------------------------------------------------- title: "ワンタイムCronの作成" description: "このページでは、サンプルコードスニペットを使用してワンタイムCronを作成するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.226Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/cron/create-one-time-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/create-one-time-cron/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/create-one-time-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/create-cron/create-one-time-cron/#CreateaOne-TimeCron) -------------------------------------------------------------------------------- # ワンタイムCronの作成 Cronコンポーネントは、ジョブのJob Poolへの送信をスケジュールするために使用されます。以下のSDKを使用すると、ジョブの送信を一度だけスケジュールするCronを作成できます。 Note: 以下のSDKは、Job Functionをトリガーするジョブ用に記述されています。他のタイプに対応させるには、適切なJob Pool IDまたはJob Pool Nameの値に置き換え、適切なTarget NameまたはTarget IDを指定する必要があります。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.cron.ZCCronDetails; import com.zc.component.jobscheduling.beans.cron.ZCCronBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobMetaDetail; import org.json.simple.JSONObject; // Functionジョブのメタデータを生成する ZCJobMetaDetail jobMeta = ZCJobBuilder.functionJobBuilder() // Functionジョブビルダーを取得する .setJobConfig(2, 15 * 60 l) // ジョブ設定 - リトライ回数 => 2回（15分間隔）（オプション） .setJobpoolName("functions_jobpool") // 関数ジョブプールの名前を設定する（オプション）（jobpoolIdまたはjobpoolNameは必須） // .setJobpoolId(1234567890L) // 関数ジョブプールのIDを設定する（オプション）（jobpoolIdまたはjobpoolNameは必須） .setTargetName("target_function") // ターゲット関数の名前を設定する（オプション）（TargetNameまたはTargetIdは必須） // .setTargetId(1234567890L) // ターゲット関数のIDを設定する（オプション）（TargetNameまたはTargetIdは必須） .setParams(new JSONObject() { { put("arg1", "job"); put("arg2", "test"); } }) // ターゲット関数に渡すパラメータを設定する（オプション） .setJobName("job_name") // ジョブ名を設定する .build(); // ジョブメタデータをビルドする // Cron詳細を生成する ZCCronDetails oneTimeCronDetails = ZCCronBuilder.zcOneTimeCronBuilder() // ワンタイムCronビルダーを取得する .setCronStatus(true) // Cronを有効に設定する .cronConfig((System.currentTimeMillis() / 1000) + (60 * 60), "America/Los_Angeles") // 実行時刻をUNIXタイムスタンプ（秒）で設定する .setJobMeta(jobMeta) // ジョブメタデータを設定する（ジョブに応じて変更） .setCronName("one_time_cron") // Cron名を設定する（一意） .setCronDescription("one_time_cron") // Cronの説明を設定する（オプション） .build(); // Cron詳細をビルドする // ワンタイムCronを作成する ZCCronDetails oneTimeCron = jobScheduling.cron.createCron(oneTimeCronDetails); Note: このSDKは動的Cronの設定にのみ使用することを推奨します。事前定義Cronの設定にはUIビルダーを使用してください。 -------------------------------------------------------------------------------- title: "定期Cronの作成" description: "このページでは、サンプルコードスニペットを使用して定期Cronを作成するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.228Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/cron/create-recurring-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/create-recurring-cron/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/create-recurring-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/create-cron/create-every-cron/#CreateanEveryCron) -------------------------------------------------------------------------------- # 定期Cronの作成 以下のSDKを使用すると、様々な時間間隔で実行できる定期Cronを作成できます。間隔は1分から暦年全体まで設定できます。 ### Every Cronの作成 以下のSDKを使用すると、**24時間**未満のスケジュール間隔でJob Poolにジョブを送信する定期Cronを作成できます。 Note: 以下のSDKは、**2時間1分3秒**ごとにジョブを送信するように設定されています。setTime()メソッドに適切な値を渡すことで、要件に応じてこの値を変更できます。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.cron.ZCCronDetails; import com.zc.component.jobscheduling.beans.cron.ZCCronBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobMetaDetail; import org.json.simple.JSONObject; // Functionジョブのメタデータを生成する ZCJobMetaDetail jobMeta = ZCJobBuilder.functionJobBuilder() // Functionジョブビルダーを取得する .setJobConfig(2, 15 * 60 l) // ジョブ設定 - リトライ回数 => 2回（15分間隔）（オプション） .setJobpoolName("functions_jobpool") // 関数ジョブプールの名前を設定する（オプション）（jobpoolIdまたはjobpoolNameは必須） // .setJobpoolId(1234567890L) // 関数ジョブプールのIDを設定する（オプション）（jobpoolIdまたはjobpoolNameは必須） .setTargetName("target_function") // ターゲット関数の名前を設定する（オプション）（TargetNameまたはTargetIdは必須） // .setTargetId(1234567890L) // ターゲット関数のIDを設定する（オプション）（TargetNameまたはTargetIdは必須） .setParams(new JSONObject() { { put("arg1", "job"); put("arg2", "test"); } }) // ターゲット関数に渡すパラメータを設定する（オプション） .setJobName("job_name") // ジョブ名を設定する .build(); // ジョブメタデータをビルドする // 定期CRON => 2時間1分3秒ごとに実行される // Cron詳細を生成する ZCCronDetails everyCronDetails = ZCCronBuilder.zcEveryCronBuilder() // Every Cronビルダーを取得する .setCronStatus(true) // Cronを有効に設定する .setTime(2, 1, 3) // 繰り返し間隔を設定する .setJobMeta(jobMeta) // ジョブメタデータを設定する（ジョブに応じて変更） .setCronName("every_cron") // Cron名を設定する（一意） .setCronDescription("every_cron") // Cronの説明を設定する（オプション） .build(); // Cron詳細をビルドする // Every Cronを作成する ZCCronDetails everyCron = jobScheduling.cron.createCron(everyCronDetails); <br> ### Daily Cronの作成 以下のSDKを使用すると、**毎日**の間隔で固定時刻にJob Poolにジョブを送信するCronをスケジュールできます。 Note: 以下のSDKは、毎日**0時0分0秒**にCronを実行するように設定されています。setTime()メソッドに適切な値を渡すことで、要件に応じてこの値を変更できます。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.cron.ZCCronDetails; import com.zc.component.jobscheduling.beans.cron.ZCCronBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobMetaDetail; import org.json.simple.JSONObject; // Functionジョブのメタデータを生成する ZCJobMetaDetail jobMeta = ZCJobBuilder.functionJobBuilder() // Functionジョブビルダーを取得する .setJobConfig(2, 15 * 60 l) // ジョブ設定 - リトライ回数 => 2回（15分間隔）（オプション） .setJobpoolName("functions_jobpool") // 関数ジョブプールの名前を設定する（オプション）（jobpoolIdまたはjobpoolNameは必須） // .setJobpoolId(1234567890L) // 関数ジョブプールのIDを設定する（オプション）（jobpoolIdまたはjobpoolNameは必須） .setTargetName("target_function") // ターゲット関数の名前を設定する（オプション）（TargetNameまたはTargetIdは必須） // .setTargetId(1234567890L) // ターゲット関数のIDを設定する（オプション）（TargetNameまたはTargetIdは必須） .setParams(new JSONObject() { { put("arg1", "job"); put("arg2", "test"); } }) // ターゲット関数に渡すパラメータを設定する（オプション） .setJobName("job_name") // ジョブ名を設定する .build(); // ジョブメタデータをビルドする // 日次CRON => 毎日0時0分0秒に実行される // Cron詳細を生成する ZCCronDetails dailyCronDetails = ZCCronBuilder.zcDailyCronBuilder() // Daily Cronビルダーを取得する .setCronStatus(true) // Cronを有効に設定する .setTime(0, 0, 0) // Cronを実行する時刻を設定する // .setTimezone("America/Los_Angeles") // タイムゾーンを設定する（オプション） .setJobMeta(jobMeta) // ジョブメタデータを設定する（ジョブに応じて変更） .setCronName("daily_cron") // Cron名を設定する（一意） .setCronDescription("daily_cron") // Cronの説明を設定する（オプション） .build(); // Cron詳細をビルドする // Daily Cronを作成する ZCCronDetails dailyCron = jobScheduling.cron.createCron(dailyCronDetails); <br> ### Monthly Cronの作成 以下のSDKを使用すると、**月次**の間隔で固定の日付と時刻にJob Poolにジョブを送信するCronをスケジュールできます。さらに、月次の間隔で特定の週にジョブを送信するオプションもあります。 日付ベースのスケジュールで月次間隔でCronを実行するよう選択した場合、**月**に基づく日付の範囲は**1〜31**になります。同様に、**週ベース**の間隔を選択した場合、範囲は**1〜4**で、特定の**曜日**の範囲は**1〜7**になります。 Note: 以下のSDKは、**毎月**の**1日**、**3日**、**5日**の**0時0分0秒**にJob Poolにジョブを送信するCronを実行するように設定されています。setTime()メソッドに適切な値を渡すことで、要件に応じてこの値を変更できます。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.cron.ZCCronDetails; import com.zc.component.jobscheduling.beans.cron.ZCCronBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobMetaDetail; import org.json.simple.JSONObject; Note: 以下のSDKスニペットで、.setWeeksOfMonth(1, 3)と.setDayOfTheWeek(1, 2)の行をコメントアウトし、.setTime(0, 0, 0)と.setDays(1, 3, 5)のコード行をコメントインすると、Cronは毎月の第1週と第3週の1日目と2日目にJob Poolにジョブを送信するようにスケジュールされます。 // Functionジョブのメタデータを生成する ZCJobMetaDetail jobMeta = ZCJobBuilder.functionJobBuilder() // Functionジョブビルダーを取得する .setJobConfig(2, 15 * 60 l) // ジョブ設定 - リトライ回数 => 2回（15分間隔）（オプション） .setJobpoolName("functions_jobpool") // 関数ジョブプールの名前を設定する（オプション）（jobpoolIdまたはjobpoolNameは必須） // .setJobpoolId(1234567890L) // 関数ジョブプールのIDを設定する（オプション）（jobpoolIdまたはjobpoolNameは必須） .setTargetName("target_function") // ターゲット関数の名前を設定する（オプション）（TargetNameまたはTargetIdは必須） // .setTargetId(1234567890L) // ターゲット関数のIDを設定する（オプション）（TargetNameまたはTargetIdは必須） .setParams(new JSONObject() { { put("arg1", "job"); put("arg2", "test"); } }) // ターゲット関数に渡すパラメータを設定する（オプション） .setJobName("job_name") // ジョブ名を設定する .build(); // ジョブメタデータをビルドする // 月次CRON => 毎月1日、3日、5日の0時0分0秒に実行される // Cron詳細を生成する ZCCronDetails monthlyCronDetails = ZCCronBuilder.zcMonthlyCronBuilder() // Monthly Cronビルダーを取得する .setCronStatus(true) // Cronを有効に設定する .setTime(0, 0, 0) // Cronを実行する時刻を設定する .setDays(1, 3, 5) // 月の日を設定する（日ベースの設定） // .setWeeksOfMonth(1, 3) // 月の週を設定する（週ベースまたは日ベースの設定が必要） // .setDayOfTheWeek(1, 2) // 曜日を設定する（週ベースまたは日ベースの設定が必要） // .setTimezone("America/Los_Angeles") // タイムゾーンを設定する（オプション） .setJobMeta(jobMeta) // ジョブメタデータを設定する（ジョブに応じて変更） .setCronName("monthly_cron") // Cron名を設定する（一意） .setCronDescription("monthly_cron") // Cronの説明を設定する（オプション） .build(); // Cron詳細をビルドする // Monthly Cronを作成する ZCCronDetails monthlyCron = jobScheduling.cron.createCron(monthlyCronDetails); <br> ### Yearly Cronの作成 以下のSDKを使用すると、**年次**の間隔で固定の月の固定の日付と時刻にジョブを送信してJob PoolにスケジュールするCronを作成できます。さらに、年次の間隔で特定の週にジョブを送信するオプションもあります。 **年次**の間隔で**日付ベース**のスケジュールでCronを実行するよう選択した場合、**月**に基づく日付の範囲は**1〜31**で、**月**は**1〜12**の値の範囲で決定されます。同様に、**週ベース**の間隔を選択した場合、範囲は**1〜4**で、特定の**曜日**の範囲は**1〜7**になります。 Note: 以下のSDKは、**毎年**の**8月**の**1日**、**2日**、**3日**にJob Poolにジョブを送信するCronを実行するように設定されています。setTime()メソッドに適切な値を渡すことで、要件に応じてこの値を変更できます。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.cron.ZCCronDetails; import com.zc.component.jobscheduling.beans.cron.ZCCronBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobMetaDetail; import org.json.simple.JSONObject; // Functionジョブのメタデータを生成する ZCJobMetaDetail jobMeta = ZCJobBuilder.functionJobBuilder() // Functionジョブビルダーを取得する .setJobConfig(2, 15 * 60 l) // ジョブ設定 - リトライ回数 => 2回（15分間隔）（オプション） .setJobpoolName("functions_jobpool") // 関数ジョブプールの名前を設定する（オプション）（jobpoolIdまたはjobpoolNameは必須） // .setJobpoolId(1234567890L) // 関数ジョブプールのIDを設定する（オプション）（jobpoolIdまたはjobpoolNameは必須） .setTargetName("target_function") // ターゲット関数の名前を設定する（オプション）（TargetNameまたはTargetIdは必須） // .setTargetId(1234567890L) // ターゲット関数のIDを設定する（オプション）（TargetNameまたはTargetIdは必須） .setParams(new JSONObject() { { put("arg1", "job"); put("arg2", "test"); } }) // ターゲット関数に渡すパラメータを設定する（オプション） .setJobName("job_name") // ジョブ名を設定する .build(); // ジョブメタデータをビルドする // 年次CRON => 年の8月の1日、2日、3日の0時0分0秒に実行される // Cron詳細を生成する ZCCronDetails yearlyCronDetails = ZCCronBuilder.zcYearlyCronBuilder() // Yearly Cronビルダーを取得する .setCronStatus(true) // Cronを有効に設定する .setTime(0, 0, 0) // Cronを実行する時刻を設定する .setDays(1, 2, 3) // 月の日を設定する // .setWeeksOfMonth(1) // 月の週を設定する（週ベースまたは日ベースの設定が必要） // .setDayOfTheWeek(3) // 曜日を設定する（週ベースまたは日ベースの設定が必要） .setMonths(8) // 月を設定する // .setTimezone("America/Los_Angeles") // タイムゾーンを設定する（オプション） .setJobMeta(jobMeta) // ジョブメタデータを設定する（ジョブに応じて変更） .setCronName("yearly_cron") // Cron名を設定する（一意） .setCronDescription("yearly_cron") // Cronの説明を設定する（オプション） .build(); // Cron詳細をビルドする // Yearly Cronを作成する ZCCronDetails yearlyCron = jobScheduling.cron.createCron(yearlyCronDetails); Note: このSDKは動的Cronの設定にのみ使用することを推奨します。事前定義Cronの設定にはUIビルダーを使用してください。 -------------------------------------------------------------------------------- title: "Cron式を使用したCronの作成" description: "このページでは、サンプルコードスニペットを使用してCron式で定義されたCronを作成するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.238Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/cron/create-cron-cron-expressions/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/key-concepts/#cron-expressions) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/create-cron-cron-expressions/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/create-cron-cron-expressions/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/create-cron/create-cron-cron-exp/#CreateaCronUsingCronExpressions) -------------------------------------------------------------------------------- # Cron式を使用したCronの作成 このSDKを使用して、Job Poolへのジョブの送信をスケジュールするCronを実装します。ただし、Cronの設定はCron式と呼ばれる正規表現のような式を使用して定義されます。 Note: 以下のSDKでは、Cron式を使用して、**毎年**の**1月**の**毎週1日目**の**0時0分0秒**にJob Poolにジョブを送信するようにCronが設定されています。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.cron.ZCCronDetails; import com.zc.component.jobscheduling.beans.cron.ZCCronBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobMetaDetail; import org.json.simple.JSONObject; // Functionジョブのメタデータを生成する ZCJobMetaDetail jobMeta = ZCJobBuilder.functionJobBuilder() // Functionジョブビルダーを取得する .setJobConfig(2, 15 * 60 l) // ジョブ設定 - リトライ回数 => 2回（15分間隔）（オプション） .setJobpoolName("functions_jobpool") // 関数ジョブプールの名前を設定する（オプション）（jobpoolIdまたはjobpoolNameは必須） // .setJobpoolId(1234567890L) // 関数ジョブプールのIDを設定する（オプション）（jobpoolIdまたはjobpoolNameは必須） .setTargetName("target_function") // ターゲット関数の名前を設定する（オプション）（TargetNameまたはTargetIdは必須） // .setTargetId(1234567890L) // ターゲット関数のIDを設定する（オプション）（TargetNameまたはTargetIdは必須） .setParams(new JSONObject() { { put("arg1", "job"); put("arg2", "test"); } }) // ターゲット関数に渡すパラメータを設定する（オプション） .setJobName("job_name") // ジョブ名を設定する .build(); // ジョブメタデータをビルドする // Cron詳細を生成する ZCCronDetails expressionCronDetails = ZCCronBuilder.zcExpressionCronBuilder() // 式Cronビルダーを取得する .setCronStatus(true) // Cronを有効に設定する .setCronExpression("0 0 * 1 1") // UNIX Cron式を設定する // .setTimezone("America/Los_Angeles") // タイムゾーンを設定する（オプション） .setCronName("expression_cron") // Cron名を設定する .setCronDescription("expression_cron") // Cronの説明を設定する（オプション） .setJobMeta(jobMeta) // ジョブメタデータを設定する .build(); // Cron詳細をビルドする // 式Cronを作成する ZCCronDetails expressionCron = jobScheduling.cron.createCron(expressionCronDetails); Note: このSDKは動的Cronの設定にのみ使用することを推奨します。事前定義Cronの設定にはUIビルダーを使用してください。 -------------------------------------------------------------------------------- title: "特定のCronの詳細を取得" description: "このページでは、サンプルコードスニペットを使用して特定のCronの詳細を取得するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.246Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/cron/get-cron-details/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/get-cron-details/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/get-cron-details/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/get-cron/#GetCronByIdentifier) -------------------------------------------------------------------------------- # 特定のCronの詳細を取得 以下のSDKを使用して、特定の**事前定義Cron**または**動的Cron**の利用可能なすべての詳細を取得します。getCron() SDKメソッドにcron idまたはCron名を渡す必要があります。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.cron.ZCCronDetails; ZCCronDetails cronA = jobScheduling.cron.getCron(12378634912l); // CronのIDでCron詳細を取得する ZCCronDetails cronB = jobScheduling.cron.getCron("test_cron"); // Cronの名前でCron詳細を取得する -------------------------------------------------------------------------------- title: "すべてのCronの詳細を取得" description: "このページでは、サンプルコードスニペットを使用してプロジェクト内のすべてのCronの詳細を取得するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.247Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/cron/get-all-cron-details/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/get-all-cron-details/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/get-all-cron-details/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/get-all-cron/#GetAllCrons) -------------------------------------------------------------------------------- # すべてのCronの詳細を取得 以下のSDKを使用すると、getCron() SDKメソッドを使用して、すべての事前定義Cronに関する利用可能な情報を取得できます。 Note: このメソッドは事前定義Cronの詳細のみを取得します。動的Cronには対応していません。 #### サンプルコードスニペット <br> import java.util.List; import com.zc.component.jobscheduling.beans.cron.ZCCronDetails; List&lt;ZCCronDetails&gt; allCrons = jobScheduling.cron.getCron(); // すべてのCron詳細を取得する -------------------------------------------------------------------------------- title: "Cronの更新" description: "このページでは、サンプルコードスニペットを使用してプロジェクト内のCronを更新するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.248Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/cron/update-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/update-cron/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/update-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/update-cron/update-one-time-cron/#UpdateaOne-TimeCron) -------------------------------------------------------------------------------- # Cronの更新 以下のSDKを使用すると、特定のCronの詳細を更新できます。このSDKを使用して、名前、説明、ターゲットを更新できます。cron idをgetCron()メソッドに渡すことで、対象のCronを選択できます。 Note: このメソッドを使用して、事前定義Cronと動的Cronの両方の詳細を更新できます。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.cron.ZCCronDetails; ZCCronDetails cron = jobScheduling.cron.getCron(12378634912l); // CronのIDでCronを取得する cron.setCronName("test_cron"); // 新しいCron名を設定する ZCCronDetails updatedCronA = jobScheduling.cron.updateCron(12378634912l, cron); // CronのIDでCronを更新する updatedCronA.setCronName("updated_test_cron"); ZCCronDetails updatedCronB = jobScheduling.cron.updateCron("test_cron", cron); // Cronの名前でCronを更新する -------------------------------------------------------------------------------- title: "Cronの一時停止" description: "このページでは、サンプルコードスニペットを使用してプロジェクト内のCronを一時停止するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.249Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/cron/pause-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/pause-cron/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/pause-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # Cronの一時停止 このSDKメソッドを使用すると、CronによるジョブのJob Poolへの送信を一時的に停止できます。一時停止したいCronのcron idまたは名前をpauseCron() SDKメソッドに渡す必要があります。 Note: このメソッドを使用して、事前定義Cronと動的Cronの両方の詳細を更新できます。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.cron.ZCCronDetails; ZCCronDetails pausedCronA = jobScheduling.cron.pauseCron(123456789l); // CronのIDでCronを一時停止する ZCCronDetails pausedCronB = jobScheduling.cron.pauseCron("test_cron"); // Cronの名前でCronを一時停止する -------------------------------------------------------------------------------- title: "Cronの再開" description: "このページでは、サンプルコードスニペットを使用してプロジェクト内の一時停止されたCronを再開するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.250Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/cron/resume-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/resume-cron/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/resume-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # Cronの再開 このSDKメソッドを使用すると、以前に一時停止されたCronの操作を再開できます。一時停止されたcron idまたは名前をresumeCron() SDKメソッドに渡すことで実行できます。 Note: このメソッドを使用して、事前定義Cronと動的Cronの両方の詳細を更新できます。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.cron.ZCCronDetails; ZCCronDetails resumedCronA = jobScheduling.cron.resumeCron(123456789l); // CronのIDでCronを再開する ZCCronDetails resumedCronB = jobScheduling.cron.resumeCron("test_cron"); // Cronの名前でCronを再開する -------------------------------------------------------------------------------- title: "Cronの実行" description: "このページでは、サンプルコードスニペットを使用してプロジェクト内のCronを実行するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.251Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/cron/run-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/run-cron/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/run-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # Cronの実行 このSDKを使用すると、Cronを実行できます。Cronが実行されると、関連付けられたジョブが即座にJob Poolに送信されます。cron idまたは名前をrunCron() SDKメソッドに渡すことで実行できます。 Note: このメソッドを使用して、事前定義Cronと動的Cronの両方の詳細を更新できます。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.job.ZCJobDetails; ZCJobDetails runCronA = jobScheduling.cron.runCron(123456789l); // CronのIDでCronを実行する ZCJobDetails runCronB = jobScheduling.cron.runCron("test_cron"); // Cronの名前でCronを実行する -------------------------------------------------------------------------------- title: "Cronの削除" description: "このページでは、サンプルコードスニペットを使用してプロジェクト内のCronを削除するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.252Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/cron/delete-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/delete-cron/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/delete-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/delete-cron/#DeleteCron) -------------------------------------------------------------------------------- # Cronの削除 このSDKメソッドを使用すると、特定のCronを削除できます。cron idまたは名前をdeleteCron() SDKメソッドに渡すことで実行できます。 Note: このメソッドを使用して、事前定義Cronと動的Cronの両方の詳細を更新できます。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.cron.ZCCronDetails; ZCCronDetails deletedCronA = jobScheduling.cron.deleteCron(123456789l); // CronのIDでCronを削除する ZCCronDetails deletedCronB = jobScheduling.cron.deleteCron("test_cron"); // Cronの名前でCronを削除する ##### Job Pool -------------------------------------------------------------------------------- title: "すべてのJob Poolの取得" description: "このページでは、サンプルコードスニペットを使用してプロジェクト内のすべてのJob Poolを取得するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.310Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/jobpool/get-all-job-pool/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/jobpool/get-all-jobpool/) - Python SDK (/ja/sdk/python/v1/job-scheduling/jobpool/get-all-jobpool/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # すべてのJob Poolの取得 以下のSDKを使用すると、利用可能なすべてのJob Poolに関するすべての利用可能な詳細を取得できます。 #### サンプルコードスニペット <br> import java.util.ArrayList; import com.zc.component.jobscheduling.beans.jobpool.ZCJobpoolDetails; ArrayList&lt;ZCJobpoolDetails&gt; jobpools = jobScheduling.getJobpool(); // すべてのjobpoolを取得 -------------------------------------------------------------------------------- title: "特定のJob Poolの取得" description: "このページでは、サンプルコードスニペットを使用してプロジェクト内の特定のJob Poolを取得するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.310Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/jobpool/get-job-pool/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/jobpool/get-job-pool/) - Python SDK (/ja/sdk/python/v1/job-scheduling/jobpool/get-job-pool/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-jobpool/#GetJobPoolbyIdentifier) -------------------------------------------------------------------------------- # 特定のJob Poolの取得 以下のSDKを使用すると、Job Poolの名前またはIDをgetJobpool() SDKメソッドに渡すことで、特定のJob Poolの詳細を取得できます。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.jobpool.ZCJobpoolDetails; ZCJobpoolDetails jobpoolA = jobScheduling.getJobpool("test_jobpool"); // jobpool名で取得 ZCJobpoolDetails jobpoolB = jobScheduling.getJobpool(1234567889L); // jobpool IDで取得 ##### Jobs -------------------------------------------------------------------------------- title: "ジョブの作成" description: "このページでは、サンプルコードスニペットを使用してジョブを作成するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.310Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/jobs/create-job/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/job/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/jobs/create-job/) - Python SDK (/ja/sdk/python/v1/job-scheduling/jobs/create-job/) - REST API Collection (/ja/api/code-reference/job-scheduling/job/submit-job/submit-webhook-job/#SubmitWebhookJobByID) -------------------------------------------------------------------------------- # ジョブの作成 以下のSDKメソッドを使用すると、Job Function、Webhook、Circuit、およびApp Sailサービスをトリガーするジョブを作成して送信できます。また、JSONキーバリューペアの形式でオプションの引数を渡すこともできます。 トリガー対象ごとのジョブの作成と送信のSDKスニペット： #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.job.ZCJobMetaDetail; import com.zc.component.jobscheduling.beans.job.ZCJobBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobDetails; import org.json.simple.JSONObject; // Functionジョブのメタデータを生成する ZCJobMetaDetail jobMeta = ZCJobBuilder.functionJobBuilder() // Functionジョブビルダーを取得する .setJobConfig(2, 15 * 60 l) // ジョブ設定 - リトライ回数 => 2回（15分間隔）（オプション） .setTargetName("target_function") // ターゲット関数の名前を設定する（オプション）（TargetNameまたはTargetIdは必須） // .setTargetId(1234567890L) // ターゲット関数のIDを設定する（オプション）（TargetNameまたはTargetIdは必須） .setParams(new JSONObject() { { put("arg1", "job"); put("arg2", "test"); } }) // ターゲット関数に渡すパラメータを設定する（オプション） .setJobName("job_name") // ジョブ名を設定する .setJobpoolName("test") // ジョブを送信するFunctionジョブプールの名前を設定する .build(); // ジョブメタデータをビルドする // Functionジョブを送信する ZCJobDetails functionJob = jobScheduling.job.submitJob(jobMeta); **以下のパッケージがインポートされていることを確認してください：** import com.zc.component.jobscheduling.beans.job.ZCJobMetaDetail; import com.zc.component.jobscheduling.beans.job.ZCJobBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobDetails; import org.json.simple.JSONObject; // Circuitジョブのメタデータを生成する ZCJobMetaDetail jobMeta = ZCJobBuilder.circuitJobBuilder() // Circuitジョブビルダーを作成する .setJobConfig(2, 15 * 60 l) // ジョブ設定 - リトライ回数 => 2回（15分間隔）（オプション） .setTargetName("target_circuit") // ターゲットサーキットの名前を設定する（オプション）（TargetNameまたはTargetIdは必須） // .setTargetId(1234567890L) // ターゲットサーキットのIDを設定する（オプション）（TargetNameまたはTargetIdは必須） .setCircuitInput(new JSONObject() { { put("key1", "value1"); put("key2", "value2"); } }) // サーキットのテストケースを設定する .setJobName("test_job") // ジョブ名を設定する .setJobpoolName("test") // ジョブを送信するCircuitジョブプールの名前を設定する .build(); // Circuitジョブメタデータをビルドする // Circuitジョブを送信する ZCJobDetails circuitJob = jobScheduling.job.submitJob(jobMeta); **以下のパッケージがインポートされていることを確認してください：** import com.zc.component.jobscheduling.beans.job.ZCJobMetaDetail; import com.zc.component.jobscheduling.beans.job.ZCJobBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobDetails; import org.json.simple.JSONObject; // Webhookジョブのメタデータを生成する ZCJobMetaDetail jobMeta = ZCJobBuilder.webhookJobBuilder() // Webhookジョブビルダーを作成する .setJobConfig(2, 15 * 60 l) // ジョブ設定 - リトライ回数 => 2回（15分間隔）（オプション） .setRequestMethod("POST") // Webhookリクエストのメソッドを設定する .setUrl("https://catalyst.zoho.com") // WebhookリクエストのURLを設定する .setParams(new JSONObject() { { put("arg1", "test"); put("arg2", "job"); } }) // Webhookリクエストのクエリパラメータを設定する（オプション） .setHeaders(new JSONObject() { { put("IS_TEST_REQUEST", "true"); } }) // Webhookリクエストのヘッダーを設定する（オプション） .setRequestBody("test_request") // Webhookリクエストのボディを設定する（オプション） .setJobName("test_job") // ジョブ名を設定する .setJobpoolName("test") // ジョブを送信するWebhookジョブプールの名前を設定する .build(); // Webhookジョブメタデータをビルドする // Webhookジョブを送信する ZCJobDetails webHookJob = jobScheduling.job.submitJob(jobMeta); **以下のパッケージがインポートされていることを確認してください：** import com.zc.component.jobscheduling.beans.job.ZCJobMetaDetail; import com.zc.component.jobscheduling.beans.job.ZCJobBuilder; import com.zc.component.jobscheduling.beans.job.ZCJobDetails; import org.json.simple.JSONObject; // AppSailジョブのメタデータを生成する ZCJobMetaDetail jobMeta = ZCJobBuilder.appSailJobBuilder() // AppSailジョブビルダーを作成する .setJobConfig(2, 15 * 60 l) // ジョブ設定 - リトライ回数 => 2回（15分間隔）（オプション） .setTargetName("test_appsail") // AppSailの名前を設定する .setRequestMethod("POST") // AppSailリクエストのメソッドを設定する .setUrl("/test") // AppSailリクエストのURLを設定する .setParams(new JSONObject() { { put("arg1", "value1"); put("arg2", "value2"); } }) // AppSailリクエストのクエリパラメータを設定する .setHeaders(new JSONObject() { { put("IS_TEST_REQUEST", "true"); } }) // AppSailリクエストのヘッダーを設定する（オプション） .setRequestBody("test_request") // AppSailリクエストのボディを設定する（オプション） .setJobName("test_job") // ジョブ名を設定する .setJobpoolName("test") // ジョブを送信するAppSailジョブプールの名前を設定する .build(); // AppSailジョブメタデータをビルドする // AppSailジョブを送信する ZCJobDetails appSailJob = jobScheduling.job.submitJob(jobMeta); -------------------------------------------------------------------------------- title: "ジョブ詳細の取得" description: "このページでは、サンプルコードスニペットを使用してジョブに関するすべての利用可能な詳細を取得するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.310Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/jobs/get-job/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/job/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/jobs/get-job/) - Python SDK (/ja/sdk/python/v1/job-scheduling/jobs/get-job/) - REST API Collection (/ja/api/code-reference/job-scheduling/job/get-job/#GetJobByID) -------------------------------------------------------------------------------- # ジョブ詳細の取得 以下のSDKメソッドを使用すると、Job Poolに送信されたジョブに関するすべての利用可能な詳細を取得できます。Job IdをgetJob() SDKメソッドに渡す必要があります。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.job.ZCJobDetails; ZCJobDetails fetchedJob = jobScheduling.job.getJob(1234567890L); // job IDでjobを取得 -------------------------------------------------------------------------------- title: "ジョブの削除" description: "このページでは、サンプルコードスニペットを使用してジョブを削除するJavaメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.311Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/job-scheduling/jobs/delete-job/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/job/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/jobs/delete-job/) - Python SDK (/ja/sdk/python/v1/job-scheduling/jobs/delete-job/) - REST API Collection (/ja/api/code-reference/job-scheduling/job/delete-job/#DeleteJobbyID) -------------------------------------------------------------------------------- # ジョブの削除 以下のSDKメソッドを使用すると、Job Pool内で実行中のジョブを削除できます。deleteJob() SDKメソッドにJob Idを渡す必要があります。 #### サンプルコードスニペット <br> import com.zc.component.jobscheduling.beans.job.ZCJobDetails; ZCJobDetails deletedJob = jobScheduling.job.deleteJob(1234567890L); // job IDでjobを削除 #### Pipelines -------------------------------------------------------------------------------- title: "Pipelineインスタンスの取得" description: "このページでは、Pipelineインスタンスを取得し、他のPipeline操作に使用する方法について説明します。" last_updated: "2026-06-10T06:04:54.312Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/pipelines/get-pipeline-instance/" service: "All Services" related: - Catalyst Pipelines (/ja/pipelines/help/pipelines/introduction) - Create a Pipeline (/ja/pipelines/help/pipelines/create-a-pipeline) - Node.js SDK (/ja/sdk/nodejs/v2/pipelines/get-pipeline-instance) - Python SDK (/ja/sdk/python/v1/pipelines/get-pipeline-instance) - REST API (/ja/api/code-reference/pipelines/get-pipeline-details) -------------------------------------------------------------------------------- # Catalyst Pipelines Catalyst Pipelinesは、Webまたはモバイルアプリケーションのビルド、テスト、およびデプロイメントの自動化を可能にするCI/CDアプローチを実装します。 Catalystコンソールからパイプラインを作成できます。以下のSDKを使用して、Catalyst Pipelineの詳細を取得し、アプリケーションにコードスニペットを組み込むことでパイプラインを実行することもできます。 #### サンプルコードスニペット <br> import com.zc.component.pipeline.ZCPipeline; import com.zc.component.pipeline.ZCPipelineDetails; import com.zc.component.pipeline.ZCPipelineRunHistory; # Pipelineインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに固有のプロパティにアクセスするために使用できるオブジェクトです。Catalyst Pipelinesで以下にリストされたアクションを実行するために、コンポーネントインスタンスを作成できます。 以下のように新しいpipelines_serviceインスタンスを作成できます。このコンポーネントインスタンスは、Java SDKのすべてのPipeline操作で使用されます。 ZCPipeline pipelines_service = ZCPipeline.getInstance(); -------------------------------------------------------------------------------- title: "Pipeline詳細の取得" description: "このページでは、既存のCatalyst Pipelineのすべての詳細を取得する方法について説明します。" last_updated: "2026-06-10T06:04:54.312Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/pipelines/get-pipeline-details/" service: "All Services" related: - Node.js SDK (/ja/sdk/nodejs/v2/pipelines/get-pipeline-instance) - Python SDK (/ja/sdk/python/v1/pipelines/get-pipeline-instance) -------------------------------------------------------------------------------- # Pipeline詳細の取得 getPipelineDetails()メソッドにパイプラインIDをパラメータとして渡すことで、Catalyst Pipelineの詳細を取得できます。パイプラインの名前、パイプラインが作成されたCatalystプロジェクトの詳細、パイプラインを作成したユーザーの詳細、作成時刻、変更が行われた場合はパイプラインを変更したユーザーの詳細、変更時刻、パイプラインのステータス、およびランナー仕様などのその他の詳細がこのメソッドのレスポンスとして返されます。 以下で使用されているpipelines_serviceリファレンスは、このコンポーネントインスタンスページで既に定義されています。 ZCPipelineDetails pipeline_details = pipelines_service.getPipelineDetails(16965000000019202L); サンプルレスポンスを以下に示します： { "status": "success", "data": { "pipeline_id": "16965000000019202L", "name": "test1", "project_details": { "project_name": "Project-Rainfall", "id": "5000000000072", "project_type": "Live" }, "created_by": { "zuid": "20257791", "is_confirmed": false, "email_id": "amelia.burrows@zylker.com", "first_name": "Amelia", "last_name": "Burrows", "user_type": "Admin", "user_id": "5000000000056" }, "created_time": "Mar 19, 2024 11:28 AM", "modified_by": { "zuid": "20257791", "is_confirmed": false, "email_id": "amelia.burrows@zylker.com", "first_name": "Amelia", "last_name": "Burrows", "user_type": "Admin", "user_id": "5000000000056" }, "modified_time": "Mar 19, 2024 11:28 AM", "git_account_id": "", "mask_regex": [ null ], "pipeline_status": "Active", "config_id": 2, "integ_id": 1 } } -------------------------------------------------------------------------------- title: "Pipelineの実行" description: "このページでは、Catalyst Pipelineを手動で実行する方法について説明します。" last_updated: "2026-06-10T06:04:54.312Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/pipelines/execute-pipeline/" service: "All Services" related: - Node.js SDK (/ja/sdk/nodejs/v2/pipelines/get-pipeline-instance) - Python SDK (/ja/sdk/python/v1/pipelines/get-pipeline-instance) -------------------------------------------------------------------------------- # Pipelineの実行 runPipeline()メソッドにパイプラインIDとブランチ名をパラメータとして渡すことで、Catalystパイプラインの実行を開始できます。また、パイプライン実行に必要な環境変数をJSONオブジェクトでこのメソッドに渡すこともでき、これは完全に任意です。このメソッドはレスポンスとしてパイプラインの実行履歴の詳細を返します。 JSONObject env = new JSONObject(); env.put("EVENT", "push"); env.put("URL", "https://www.google.com"); ZCPipelineRunHistory run = pipelines_service.runPipeline(8431000000161112051L,main,env); サンプルレスポンスを以下に示します： { "status": "success", "data": { "history_id": "5000000021007", "pipeline_id": "8431000000161112051L", "event_time": "Mar 20, 2024 02:02 PM", "event_details": { "BRANCH_NAME": "detective_pre", "EVENT": "push", "URL": "https://www.google.com" }, "history_status": "Queued" } } #### QuickML -------------------------------------------------------------------------------- title: "QuickMLエンドポイントの実行" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してQuickMLエンドポイントを実行する方法について説明します。" last_updated: "2026-06-10T06:04:54.312Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/quickml/execute-quickml-endpoints/" service: "QuickML" related: - QuickML (/ja/quickml/) - QuickML Pipeline Endpoints (/ja/quickml/help/pipeline-endpoints/) -------------------------------------------------------------------------------- # Catalyst QuickML Catalyst QuickMLは、ノーコードの機械学習パイプラインビルダーサービスで、事前構築されたMLアルゴリズム、操作、データ前処理技術を実装し、データセットと接続してMLモデルを構築・公開できます。データパイプラインとMLパイプラインを公開した後、認証済みエンドポイントで作成したモデルにアクセスできます。 ### QuickMLエンドポイントの実行 以下のコードスニペットを使用すると、公開されたQuickMLエンドポイントに入力データを渡し、MLモデルの処理に基づいて結果を予測できます。出力は、MLパイプライン作成時に定義されたターゲットカラムの値の予測を返します。 Note: 1. 以下のコードスニペットで結果を予測する前に、Catalystコンソールを使用してプロジェクトにMLパイプラインとモデルのエンドポイントを設定し公開しておく必要があります。 2. QuickMLは現在、JP、SA、またはCAデータセンターからアクセスするCatalystユーザーには利用できません。 モデルのエンドポイントへの入力データは、ハッシュマップを通じてキーバリューペアとして渡されます。以下に記載されているendpoint_keyは、プロジェクトで設定されたMLモデル用に公開されたエンドポイントの一意のIDです。エンドポイントキーと入力データは実行のためにpredict()メソッドに渡されます。 #### サンプルコードスニペット <br> import java.util.HashMap; import com.zc.component.quickml.ZCQuickML; import com.zc.component.quickml.ZCQuickMLDetail; // 入力データ HashMap&lt;String, String&gt; map= new HashMap<>(); //データセットに応じて列名と値を指定する map.put("column_name1", "value1"); map.put("column_name2", "value2"); map.put("column_name3", "value3"); String EndPointKey = "c8c7b4bfd8fdf4f29b9499fjhd9d03f5b2a79cd4792b302e26934a3db984214fd4cfc8049bba7acb15fe73eac0d15af59"; // Catalyst UIからコピーしたエンドポイントキー // QuickMLインスタンスを作成する ZCQuickML quickMlInstance = ZCQuickML.getInstance(); // メソッドを実行する ZCQuickMLDetail result = quickMlInstance.predict(EndPointKey, map); System.out.println(result.getStatus()); // 結果のステータスを返す System.out.print(result.getResult()); // 結果のデータを返す #### Serverless ##### AppSail -------------------------------------------------------------------------------- title: "AppSailでのSDKの実装" description: "このページでは、AppSailサービスにJava SDKを実装し、アプリケーション内でCatalyst機能を利用する方法について説明します。" last_updated: "2026-06-10T06:04:54.313Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/serverless/appsail/implement-sdk-in-appsail/" service: "Serverless" related: - AppSail Help (/ja/serverless/help/appsail/introduction) -------------------------------------------------------------------------------- # Catalyst AppSail Catalyst AppSailは、Catalyst Serverlessの完全マネージド型の独立したPlatform-as-a-Service（PaaS）コンポーネントで、クラウド上でのサービスの開発とデプロイを容易にします。AppSailアプリケーションはCatalyst固有のコーディング構造に依存せずに構築でき、Catalystはこの目的のために強力でスケーラブルなプラットフォームを提供します。AppSailはFlask、Django、Bottle、CherryPyなど、Pythonのすべてのフレームワークをサポートしています。 ### AppSailでのPython SDKの実装 AppSailサービスのコードベースにCatalyst Python SDKを簡単に実装できます。SDKは各リクエストの前にリクエストオブジェクトで初期化する必要があります。 以下はFlask WebアプリでPython SDKをインポートおよび初期化する例です。 from flask import Flask, request, g import os import zcatalyst_sdk from zcatalyst_sdk.catalyst_app import CatalystApp app = Flask(__name__) @app.before_request def before_request(): if request.path.startswith('/admin'): return 'Unauthorized', 401 # 認可済みユーザーの場合 g.zc_app = zcatalyst_sdk.initialize(req=request) @app.route('/') def index(): return 'Web App with Python Flask!' @app.route('/cache') def cache(): app: CatalystApp = g.zc_app resp = app.cache().segment().put('key', 'value') return resp, 200 listen_port = os.getenv('X_ZOHO_CATALYST_LISTEN_PORT', 9000) app.run(host='0.0.0.0', port = listen_port) Info : 上記の操作を実行するために必要な権限レベルについては、SDKスコープテーブルを参照してください。 ##### Circuits -------------------------------------------------------------------------------- title: "Circuitの実行" description: "このページでは、サンプルコードスニペットを使用してJavaアプリケーションでCircuitを活用しタスクを整理・オーケストレーションする方法について説明します。" last_updated: "2026-06-10T06:04:54.314Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/serverless/circuits/execute-circuit/" service: "Serverless" related: - Execute Circuit - API (/ja/api/code-reference/serverless/circuits/execute-circuit/#ExecuteCircuit) - Circuits (/ja/serverless/help/circuits/introduction) -------------------------------------------------------------------------------- # Circuitの実行 Catalyst Circuitsを使用すると、自動的に実行される一連のタスクを定義、整理、オーケストレーションできます。Circuit内でCatalyst Functionの並行実行または順次実行を有効にし、さらに条件、データ、パスを含めてワークフローを自動化できます。 Note: Circuitsは現在、EU、AU、IN、JP、SA、またはCAデータセンターからアクセスするCatalystユーザーには利用できません。 以下のサンプルコードは、一意のCircuit IDを参照してCircuitを実行し、キーバリューペアをCircuitへの入力JSONとして渡す方法を示しています。また、Circuitの実行履歴に保存された一意のExecution IDを参照して、Circuitの実行詳細を取得する方法も示しています。 ZCCircuitDetailsはCircuitを参照するために使用され、ZCCircuitExecutionDetailsはCircuitの実行詳細を返します。 #### サンプルコードスニペット <br> import org.json.simple.JSONObject; import com.zc.component.circuits.ZCCircuit; import com.zc.component.circuits.ZCCircuitDetails; import com.zc.component.circuits.ZCCircuitExecutionDetails; import com.zc.component.circuits.ZCCircuitExecutionStatus; //サーキットIDを参照してサーキットを実行し、入力JSONを渡す ZCCircuitDetails userBackupCircuit = ZCCircuit.getInstance().getCircuitInstance(1239000000L); JSONObject execInputJson = new JSONObject(); execInputJson.put("key", "value"); ZCCircuitExecutionDetails circuitExecution = userBackupCircuit.execute("Case 1",execInputJson); String executionId = circuitExecution.getExecutionId(); //実行IDを返す //サーキットの実行IDを参照してサーキットの実行詳細を返す。 //独自の成功ロジックをここに記述できます。 ZCCircuitDetails userBackupCircuit = ZCCircuit.getInstance().getCircuitInstance(1239000000L); ZCCircuitExecutionDetails circuitExecution = userBackupCircuit.getExecutionDetails(executionId); if(circuitExecution.getStatus().equals(ZCCircuitExecutionStatus.SUCCESS)) { //成功時のロジック } //サーキットの実行IDを参照してサーキットの実行を中断する ZCCircuitDetails userBackupCircuit = ZCCircuit.getInstance().getCircuitInstance(1239000000L); userBackupCircuit.abortExecution(executionId); ##### ファンクション -------------------------------------------------------------------------------- title: "Functionの実行" description: "このページでは、サンプルコードスニペットを使用してJavaアプリケーションでFunctionを実行する方法について説明します。" last_updated: "2026-06-10T06:04:54.314Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/serverless/functions/execute-function/" service: "Serverless" related: - Execute Function - API (/ja/api/code-reference/serverless/functions/execute-function/#ExecuteFunction) - Functions (/ja/serverless/help/functions/introduction) -------------------------------------------------------------------------------- # Functionの実行 CatalystのFunctionグループは、オンラインエディターまたはCommand Line Interface（CLI）を使用して作成および定義されます。Functionグループを実行して、その機能を検証できます。 ### Functionの実行 Functionエンドポイントを実行する必要がある場合は、以下のコードスニペットを使用できます。ここでは、FunctionのパラメータがJSONオブジェクトとして構築され、executeFunction()メソッドを通じて渡されます。 function IDは自動生成される数値のlong integer値です。 #### サンプルコードスニペット <br> import org.json.simple.JSONObject; import com.zc.functions.ZCatalystFunction; //パラメーター追加用JSONObjectを作成する JSONObject jsonobj = new JSONObject(); //メソッドに渡すためにパラメータをキー・バリューペアとして追加する jsonobj.put("Name", "Amelia"); //JSONオブジェクトで関数groupIdを参照してメソッドを実行する Object result = ZCatalystFunction.getInstance().getFunctionInstance(1510000000054095L).executeFunction(jsonobj); Note: function IDの代わりに、Function名を文字列としてgetFunctionInstance()メソッドに渡すこともできます。 #### SmartBrowz -------------------------------------------------------------------------------- title: "PDFとスクリーンショット" description: "このページでは、PDFおよびスクリーンショットを生成する方法について説明します。" last_updated: "2026-06-10T06:04:54.314Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/smartbrowz/generate-pdfnscreenshot/" service: "SmartBrowz" related: - PDF & Screenshot - API (/ja/api/code-reference/smartbrowz/generate-pdfnscreenshoturl/#PDF%26ScreenshotwithHTML%2fURLasInput) -------------------------------------------------------------------------------- # PDF & Screenshot Catalyst SmartBrowzは、コードを通じてビジュアルドキュメントを生成するためのPDF & Screenshotコンポーネントを提供します。以下のコードをコピーしてアプリケーションロジックに貼り付けることで、この機能をアプリケーションに組み込むことができます。 以下のSDKを使用すると、HTML、URL、またはテンプレートを入力として使用してビジュアルドキュメントを生成できます。 #### サンプルコードスニペット <br> import com.zc.component.smartbrowz.ZCSmartBrowz; import com.zc.component.smartbrowz.ZCSmartBrowzConvertDetails; ### 事前定義テンプレートからビジュアルドキュメントを生成 // SmartBrowzを初期化 ZCSmartBrowz smartBrowz = ZCSmartBrowz.getInstance(); // 事前定義されたテンプレートから出力を生成する ObjectMapper mapper = new ObjectMapper(); JsonNode templateData = mapper.createObjectNode(); ((ObjectNode)templateData).put("name", "Amelia Burrows"); ((ObjectNode)templateData).put("age", "34"); ((ObjectNode)templateData).put("address", "Houstan"); ((ObjectNode)templateData).put("country", "USA"); ((ObjectNode)templateData).put("email", "emma@zylker.com"); ZCSmartBrowzPDFOptions pdfOptions = ZCSmartBrowzPDFOptions.getInstance(); pdfOptions.setDisplayHeaderFooter(true); pdfOptions.setFormat("A4"); pdfOptions.setPageRanges("1-2"); pdfOptions.setPrintBackground(true);; pdfOptions.setPassword("Siva123"); // UIでテンプレートのパスワード設定を有効にした後、パスワードを設定 pdfOptions.setLandscape(true); pdfOptions.setScale(new BigDecimal("1.0")); pdfOptions.setWidth("100"); pdfOptions.setHeight("100"); ZCSmartBrowzNavigationOptions navigationOptions = new ZCSmartBrowzNavigationOptions(); navigationOptions.setWaitUntil("domcontentloaded"); navigationOptions.setTimeout(30000); ZCSmartBrowzPageOptions pageOptions = new ZCSmartBrowzPageOptions(); ContentDetails contentDetails = new ContentDetails(); contentDetails.setContent("&lt;html&gt;&lt;body&gt;Hello World&lt;/body&gt;&lt;/html&gt;"); pageOptions.setCss(contentDetails); pageOptions.setDevice("Blackberry PlayBook"); pageOptions.setJavaScriptEnabled(true); ViewportDetails viewportDetails = new ViewportDetails(); viewportDetails.setHeight(800); viewportDetails.setWidth(600); pageOptions.setViewport(viewportDetails); ZCSmartBrowzTemplateOptions templateOptions = ZCSmartBrowzTemplateOptions.getInstance(); templateOptions.setPdfDetails(pdfOptions); templateOptions.setNavigationDetails(navigationOptions); templateOptions.setOutputType(ZC_CONVERT_OUTPUT_TYPE.PDF); templateOptions.setPageDetails(pageOptions); templateOptions.setTemplateInput(templateData); templateOptions.setTemplateId(2075000000021001L); InputStream outputStream = smartBrowz.generateFromTemplate(templateOptions); ### HTMLからPDFに変換 // SmartBrowzを初期化 ZCSmartBrowz smartBrowz = ZCSmartBrowz.getInstance(); // HTMLからPDFに変換する ZCSmartBrowzConvertDetails convertDetailsForPDF = ZCSmartBrowzConvertDetails.getInstance(); ZCSmartBrowzPDFOptions pdfOptions = ZCSmartBrowzPDFOptions.getInstance(); pdfOptions.setDisplayHeaderFooter(true); pdfOptions.setFormat("A4"); MarginDetails marginDetails = new MarginDetails(); marginDetails.setTop("10"); marginDetails.setRight("10"); marginDetails.setLeft("10"); marginDetails.setBottom("10"); pdfOptions.setMargin(marginDetails); pdfOptions.setPageRanges("1-2"); pdfOptions.setPrintBackground(true);; pdfOptions.setPassword("Siva123"); pdfOptions.setLandscape(true); pdfOptions.setScale(new BigDecimal("1.0")); pdfOptions.setWidth("100"); pdfOptions.setHeight("100"); ZCSmartBrowzNavigationOptions navigationOptions = new ZCSmartBrowzNavigationOptions(); navigationOptions.setWaitUntil("domcontentloaded"); navigationOptions.setTimeout(30000); ZCSmartBrowzPageOptions pageOptions = new ZCSmartBrowzPageOptions(); ContentDetails contentDetails = new ContentDetails(); contentDetails.setContent("&lt;html&gt;&lt;body&gt;Hello World&lt;/body&gt;&lt;/html&gt;"); pageOptions.setCss(contentDetails); pageOptions.setDevice("Blackberry PlayBook"); pageOptions.setJavaScriptEnabled(true); ViewportDetails viewportDetails = new ViewportDetails(); viewportDetails.setHeight(800); viewportDetails.setWidth(600); pageOptions.setViewport(viewportDetails); convertDetailsForPDF.setPdfDetails(pdfOptions); convertDetailsForPDF.setNavigationDetails(navigationOptions); convertDetailsForPDF.setPageDetails(pageOptions); convertDetailsForPDF.setHtml("&lt;html&gt;Hello&lt;/html&gt;"); InputStream outPutStream = smartBrowz.convertToPdf(convertDetailsForPDF); ### URLからスクリーンショットを取得 // SmartBrowzを初期化 ZCSmartBrowz smartBrowz = ZCSmartBrowz.getInstance(); // URLからPDFに変換する ZCSmartBrowzConvertDetails convertDetailsForPDF = ZCSmartBrowzConvertDetails.getInstance(); ZCSmartBrowzPDFOptions pdfOptions = ZCSmartBrowzPDFOptions.getInstance(); pdfOptions.setDisplayHeaderFooter(true); pdfOptions.setFormat("A4"); MarginDetails marginDetails = new MarginDetails(); marginDetails.setTop("10"); marginDetails.setRight("10"); marginDetails.setLeft("10"); marginDetails.setBottom("10"); pdfOptions.setMargin(marginDetails); pdfOptions.setPageRanges("1-2"); pdfOptions.setPrintBackground(true);; pdfOptions.setPassword("Siva123"); pdfOptions.setLandscape(true); pdfOptions.setScale(new BigDecimal("1.0")); pdfOptions.setWidth("100"); pdfOptions.setHeight("100"); ZCSmartBrowzNavigationOptions navigationOptions = new ZCSmartBrowzNavigationOptions(); navigationOptions.setWaitUntil("domcontentloaded"); navigationOptions.setTimeout(30000); ZCSmartBrowzPageOptions pageOptions = new ZCSmartBrowzPageOptions(); ContentDetails contentDetails = new ContentDetails(); contentDetails.setContent("&lt;html&gt;&lt;body&gt;Hello World&lt;/body&gt;&lt;/html&gt;"); pageOptions.setCss(contentDetails); pageOptions.setDevice("Blackberry PlayBook"); pageOptions.setJavaScriptEnabled(true); ViewportDetails viewportDetails = new ViewportDetails(); viewportDetails.setHeight(800); viewportDetails.setWidth(600); pageOptions.setViewport(viewportDetails); convertDetailsForPDF.setPdfDetails(pdfOptions); convertDetailsForPDF.setNavigationDetails(navigationOptions); convertDetailsForPDF.setPageDetails(pageOptions); convertDetailsForPDF.setUrl("http://www.example.com"); InputStream outPutStream = smartBrowz.convertToPdf(convertDetailsForPDF); コンソールのPDF & Screenshotセクションでは、Playground機能を使用してこのコンポーネントを直接テストしたり、コンソールから直接SDKをコピーしたりできます。 Note: Browser Logic Functionを使用してコーディングするブラウザアクションや操作、またはCatalyst SmartBrowzのいずれかのコンポーネントを使用して実行するブラウザ自動化やWebスクレイピングタスクは、すべてお客様自身の責任で行ってください。SmartBrowzコンポーネントは、アクションが許可されているドメインで、または適切な承認を得た上で操作を実行するために使用することを強く推奨します。また、Catalystはファンクションをコーディングするための安全なインフラストラクチャを提供しますが、Catalyst Functionを使用してコーディングしたロジックの結果に関する責任はお客様にあります。 ##### Browser Grid -------------------------------------------------------------------------------- title: "概要" description: "このページでは、Browser Grid操作を実行するために使用できるSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.315Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/smartbrowz/browser-grid/overview/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/smartbrowz/browser-grid/overview/) - Python SDK (/ja/sdk/python/v1/smartbrowz/browser-grid/overview/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # 概要 Browser Gridは、*Catalyst SmartBrowz*サービスのオートスケーリングコンポーネントであり、複数のヘッドレスブラウザを構成および管理できます。プロセスに必要なノード数やブラウザ数を構成することで、必要なGridを設定するオプションが提供されます。 Browser Grid Java SDKを使用すると、Browser Gridの詳細取得、Browser Gridのノード詳細取得、およびBrowser Gridの実行終了を行うことができます。 ### SDKメソッド一覧 <table class="content-table"> <thead> <tr> <th class="w25p">カテゴリ</th> <th class="w50p">SDKメソッド</th> <th class="w25p">スコープ要件</th> </tr> </thead> <tbody> <tr> <td>一般操作</td> <td>Browser Gridインスタンスの取得</td> <td>Admin</td> </tr> <tr> <td>Browser Grid操作</td> <td> <ul> <li>すべてのBrowser Gridの取得</li> <li>特定のBrowser Gridの取得</li> <ul> <li>IDによる特定のBrowser Gridの取得</li> <li>名前による特定のBrowser Gridの取得</li> </ul> <li>Gridのノードの取得</li> <ul> <li>Grid IDの使用</li> <li>Grid名の使用</li> </ul> <li>Browser Gridの停止</li> <ul> <li>Grid IDの使用</li> <li>Grid名の使用</li> </ul> </ul> </td> <td>Admin</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "Browser Gridインスタンスの取得" description: "このページでは、Browser Grid操作を実行するために使用できるSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.315Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/smartbrowz/browser-grid/get-instance/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/smartbrowz/browser-grid/get-instance/) - Python SDK (/ja/sdk/python/v1/smartbrowz/browser-grid/get-instance/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # Browser Gridインスタンスの取得 以下に示すようにBrowser Gridインスタンスを取得できます。これはサーバーサイドの呼び出しを発生させません。Browser Gridコンポーネントを使用する際の各種コードスニペットで、このコンポーネントインスタンスを参照します。 **以下のパッケージをインポートしてください** import com.zc.component.smartbrowz.*; ZCBrowserGrid grid = ZCBrowserGrid.getInstance()// プロジェクトのインスタンスを取得 -------------------------------------------------------------------------------- title: "すべてのBrowser Grid詳細の取得" description: "このページでは、Browser Grid操作を実行するために使用できるSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.315Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/smartbrowz/browser-grid/get-all-grids/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/smartbrowz/browser-grid/get-all-grids/) - Python SDK (/ja/sdk/python/v1/smartbrowz/browser-grid/get-all-grids/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # すべてのBrowser Grid詳細の取得 getGrid() SDKメソッドを使用して、プロジェクト内に存在するすべてのBrowser Gridの詳細を取得できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 **以下のパッケージをインポートしてください** import com.zc.component.smartbrowz.*; List<\ZCGrid> gridList = grid.getGrid(); // プロジェクトに存在するすべてのグリッドの詳細リストを返します。 ### 期待されるレスポンスの例 { "status": "success", "data": [ { "id": "3970000000006058", "name": "play", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 07:04 PM", "modified_time": "Sep 10, 2025 07:04 PM", "api_key_modified_time": "1757511270919", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 1, "max_session_count": 1, "max_nodes_count": 10, "max_concurrent_count": 10, "config_type": 1 }, { "id": "3970000000005426", "name": "Automation", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 12:47 PM", "modified_time": "Sep 23, 2025 03:12 PM", "api_key_modified_time": "1757488669690", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 2, "max_session_count": 1, "max_nodes_count": 5, "max_concurrent_count": 5, "config_type": 2 }, { "id": "3970000000005027", "name": "SDK", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 11:33 AM", "modified_time": "Sep 10, 2025 04:27 PM", "api_key_modified_time": "1757484201284", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 2, "max_session_count": 1, "max_nodes_count": 5, "max_concurrent_count": 5, "config_type": 1 }, { "id": "3970000000005015", "name": "Puppeteer_Grid", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 10:21 AM", "modified_time": "Sep 10, 2025 10:21 AM", "api_key_modified_time": "1757479864798", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 1, "max_session_count": 1, "max_nodes_count": 1, "max_concurrent_count": 1, "config_type": 1 }, { "id": "3970000000005013", "name": "Selenium_Gridt", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 10:21 AM", "modified_time": "Sep 23, 2025 05:50 PM", "api_key_modified_time": "1757479864794", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 2, "max_session_count": 1, "max_nodes_count": 1, "max_concurrent_count": 1, "config_type": 2 } ] } -------------------------------------------------------------------------------- title: "特定のBrowser Gridの取得" description: "このページでは、Browser Grid操作を実行するために使用できるSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.315Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/smartbrowz/browser-grid/get-specific-grid/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/smartbrowz/browser-grid/get-specific-grid/) - Python SDK (/ja/sdk/python/v1/smartbrowz/browser-grid/get-specific-grid/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # 特定のBrowser Gridの取得 Grid IDまたはGrid名をgetGrid() SDKメソッドに渡すことで、プロジェクト内の特定のBrowser Gridの詳細を取得できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 ### Grid IDの使用 対象のBrowser Gridの**Grid ID**をgetGrid() SDKメソッドに渡すことができます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 **以下のパッケージをインポートしてください** import com.zc.component.smartbrowz.*; ZCBrowserGrid gridDetails = grid.getGrid(3970000000005013l); // Grid IDを使用してグリッドの詳細を取得 ### Grid名の使用 対象のBrowser Gridの名前をgetGrid() SDKメソッドに渡すことができます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 **以下のパッケージをインポートしてください** import com.zc.component.smartbrowz.*; ZCBrowserGrid gridDetails = grid.getGrid("Selenium_Grid"); // グリッド名を使用してグリッドの詳細を取得 ### 期待されるレスポンスの例 { "status": "success", "data": { "id": "3970000000006058", "name": "Selenium_Grid", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 07:04 PM", "modified_time": "Sep 24, 2025 11:55 AM", "api_key_modified_time": "1757511270919", "created_by": { "zuid": "111734674", "is_confirmed": false, "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "is_confirmed": false, "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 1, "max_session_count": 1, "max_nodes_count": 10, "max_concurrent_count": 10, "config_type": 1 } } -------------------------------------------------------------------------------- title: "ノードの詳細の取得" description: "このページでは、Browser Grid操作を実行するために使用できるSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.315Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/smartbrowz/browser-grid/get-specific-node/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/smartbrowz/browser-grid/get-specific-node/) - Python SDK (/ja/sdk/python/v1/smartbrowz/browser-grid/get-specific-node/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # ノードの詳細の取得 対象のBrowser Gridの**Grid ID**または名前をgetGridNodes() SDKメソッドに渡すことで、そのGrid内のノードの詳細を取得できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 ### Grid IDの使用 対象のBrowser Gridの**Grid ID**をgetGridNodes() SDKメソッドに渡すことで、ノードの詳細を取得できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 **以下のパッケージをインポートしてください** import com.zc.component.smartbrowz.*; ZCBrowserGrid nodeDetails = grid.getGridNodes(3970000000005013l); // Grid IDを使用してノードの詳細を取得 ### Grid名の使用 対象のBrowser Gridの名前をgetGridNodes() SDKメソッドに渡すことで、ノードの詳細を取得できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 **以下のパッケージをインポートしてください** import com.zc.component.smartbrowz.*; ZCBrowserGrid gridDetails = grid.getGridNodes("Selenium_Grid"); // グリッド名を使用してノードの詳細を取得 -------------------------------------------------------------------------------- title: "Browser Gridの停止" description: "このページでは、Browser Grid操作を実行するために使用できるSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.315Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/smartbrowz/browser-grid/stop-grid/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Node.js SDK (/ja/sdk/nodejs/v2/smartbrowz/browser-grid/stop-grid/) - Python SDK (/ja/sdk/python/v1/smartbrowz/browser-grid/stop-grid/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # Browser Gridの停止 対象のBrowser Gridの**Grid ID**または名前をstopGrid() SDKメソッドに渡すことで、すべての実行を終了しBrowser Gridを停止できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 ### Grid IDの使用 対象のBrowser Gridの**Grid ID**をstopGrid() SDKメソッドに渡すことで、Gridを停止し、すべての実行を終了できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 **以下のパッケージをインポートしてください** import com.zc.component.smartbrowz.*; ZCBrowserGrid gridTerminate = grid.stopGrid(3970000000005013l); // Grid IDを使用してグリッドを停止 ### Grid名の使用 対象のBrowser Gridの名前をstopGrid() SDKメソッドに渡すことで、Gridを停止し、すべての実行を終了できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 **以下のパッケージをインポートしてください** import com.zc.component.smartbrowz.*; ZCBrowserGrid gridTerminate = grid.stopGrid("Selenium_Grid"); //グリッド名を使用してグリッドを停止する ### 期待されるレスポンスの例 { "status": "success", "data": true } #### Zia Services -------------------------------------------------------------------------------- title: "OCR" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用して光学文字認識機能でテキスト文字を検出する方法について説明します" last_updated: "2026-06-10T06:04:54.319Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/ocr/" service: "Zia Services" related: - OCR - API (/ja/api/code-reference/zia-services/ocr/#OCR) -------------------------------------------------------------------------------- # Optical Character Recognition Zia Optical Character Recognitionは、画像やデジタルドキュメント内のテキスト文字を電子的に検出し、機械エンコードされたテキストに変換します。Zia OCRは、9つの国際言語と10のインド言語のテキストを認識できます。APIドキュメントから言語と言語コードの一覧を確認できます。 注: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたファイルは一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。 OCRで処理する必要がある画像またはドキュメントファイルのパスを、以下のコードに示すように指定する必要があります。サンプルコードに示すように、受信したレスポンスをフォーマットすることもできます。レスポンスには、認識されたテキストに加えて、処理の精度を定義する信頼度スコアも含まれます。 許可されるファイル形式: ._jpg,_ ._jpeg_, ._png_, ._tiff_, ._bmp_, ._pdf_ ファイルサイズ制限: 20 MB setModelType()でモデルタイプをOCRとして指定し、setLanguageCodeで言語コードを指定する必要があります。これらの値はOCRモデルタイプではオプションです。デフォルトではOCRモデルタイプとして処理され、言語が指定されていない場合は自動的に検出されます。 #### サンプルコードスニペット <br> import com.zc.component.ml.ZCContent; import com.zc.component.ml.ZCLine; import com.zc.component.ml.ZCML; import com.zc.component.ml.ZCOCRModelType; import com.zc.component.ml.ZCOCROptions; import com.zc.component.ml.ZCParagraph; import java.io.File; File file = new File("/Users/amelia-421/Desktop/MyImage.webp"); //ファイルパスを指定する ZCOCROptions options = ZCOCROptions.getInstance().setModelType(ZCOCRModelType.OCR).setLanguageCode("eng,tam"); //モデルタイプと言語を設定する ZCContent ocrContent = ZCML.getInstance().getContent(file, options); //ファイルオブジェクトでgetContent()を呼び出して、ZCContentオブジェクトで検出されたテキストを取得する //個別の段落リストを取得する paragraphs = ocrContent.getParagraphs(); for(ZCParagraph paragraph : paragraphs) { //段落内の個別の行を取得する List paraLines = paragraph.lines; for(ZCLine line : paraLines) { //行内の個別の単語を取得する String words = line.words; String text = line.text; //生の行テキスト } String text = paragraph.text; //段落の生テキストを返す } String text = ocrContent.text; //画像の生テキストを返す -------------------------------------------------------------------------------- title: "顔分析" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してFace Analytics機能で指定された条件に基づいて顔を検出する方法について説明します" last_updated: "2026-06-10T06:04:54.319Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/face-analytics/" service: "Zia Services" related: - Face Analytics - API (/ja/api/code-reference/zia-services/face-analytics/#FaceAnalytics) -------------------------------------------------------------------------------- # Face Analytics Zia Face Analyticsは、画像内の顔検出を実行し、顔の特徴を分析して、検出された顔の性別、年齢、感情などの情報を提供します。 詳細については、Face Analyticsヘルプページをご覧ください。 入力として._jpg_/._jpeg_または._png_ファイルを提供する必要があります。リクエストとレスポンスの形式については、APIドキュメントを参照してください。 属性をtrueまたはfalseに設定することで、年齢、笑顔、性別の検出を有効または無効にできます。また、モードをBASIC、MODERATE、またはADVANCEDに指定することもできます。これらの値はオプションです。デフォルトでは、すべての属性が検出され、ADVANCEDモードで処理されます。 レスポンスは、有効化された属性の予測、各顔の顔の特徴の座標とランドマーク、および各分析の信頼度スコアを返します。 #### サンプルコードスニペット <br> import com.zc.component.ml.ZCAge; import com.zc.component.ml.ZCAnalyseMode; import com.zc.component.ml.ZCFaceAnalysisData; import com.zc.component.ml.ZCFaceAnalyticsOptions; import com.zc.component.ml.ZCFaceEmotion; import com.zc.component.ml.ZCFaceLandmark; import com.zc.component.ml.ZCFacePoints; import com.zc.component.ml.ZCFaces; import com.zc.component.ml.ZCGender; import com.zc.component.ml.ZCML; import java.io.File; File file = new File("{filePath}"); //ファイルパスを指定する //各属性検出を必須または任意に設定し、検出モードを設定する ZCFaceAnalyticsOptions options = ZCFaceAnalyticsOptions.getInstance().setAgeNeeded(false) .setEmotionNeeded(true).setGenderNeeded(true).setAnalyseMode(ZCAnalyseMode.ADVANCED); ZCFaceAnalysisData faceData = ZCML.getInstance().analyzeFace(file, options); //ファイルとオプションでanalyzeFace()を呼び出す Long facesCount = faceData.getFacesCount(); //画像内の顔の数を取得する List faces = faceData.getFacesList(); for(ZCFaces face : faces) { //検出された各顔に対して実行される Double faceConfidence = face.getConfidence(); //各分析の信頼度スコアを取得する ZCAge age = face.getAge(); //顔の年齢を取得する ZCGender gender = face.getGender(); //顔の性別を取得する ZCFaceEmotion emotion = face.getEmotion(); //笑顔情報を取得する ZCFacePoints facePoints = face.getCoordinates(); //顔の座標を取得する List faceLandmarks = face.getFaceLandmarks(); //顔の特徴のランドマークを取得する } -------------------------------------------------------------------------------- title: "画像モデレーション" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してImage Moderation機能で画像内の脆弱性を検出する方法について説明します" last_updated: "2026-06-10T06:04:54.319Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/image-moderation/" service: "Zia Services" related: - Image-Moderation - API (/ja/api/code-reference/zia-services/image-moderation/#ImageModeration) -------------------------------------------------------------------------------- # Image Moderation Image Moderationは、画像内の不適切で安全でないコンテンツを検出し認識します。基準には、示唆的または露骨なきわどいコンテンツ、ヌード、暴力、流血、武器や薬物の存在が含まれます。 詳細については、Image Moderationヘルプページをご覧ください。 入力として._jpg_/._jpeg_または._png_ファイルを提供できます。リクエストとレスポンスの形式については、APIドキュメントを参照してください。 モデレーションモードをオプションでBASIC、MODERATE、またはADVANCEDに設定できます。デフォルトでは、画像はADVANCEDモードで処理されます。 レスポンスは、各基準の確率とその信頼度スコア、および画像がsafe\_to\_useまたはunsafe\_to\_useであるかの予測を返します。 #### サンプルコードスニペット <br> import com.zc.component.ml.ZCAnalyseMode; import com.zc.component.ml.ZCImageModerateData; import com.zc.component.ml.ZCImageModerationConfidence; import com.zc.component.ml.ZCImageModerationOptions; import com.zc.component.ml.ZCImageModerationPrediction; import com.zc.component.ml.ZCML; import java.io.File; File file = new File("{filePath}"); //ファイルパスを指定する ZCImageModerationOptions options = ZCImageModerationOptions.getInstance().setAnalyseMode(ZCAnalyseMode.ADVANCED); //モデレーションモードを設定する ZCImageModerateData imData = ZCML.getInstance().moderateImage(file, options); //入力ファイルでmoderateImage()を呼び出す and options ZCImageModerationPrediction prediction = imData.getPrediction(); //最終予測Doubleを取得する predictionConfidence = imData.getConfidence(); //最終予測の信頼度スコアリストを取得する List confidences = imData.getImageModerationConfidenceList(); //予測された各基準の信頼度スコアを取得する -------------------------------------------------------------------------------- title: "物体認識" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してObject Recognition機能でオブジェクトを検出する方法について説明します" last_updated: "2026-06-10T06:04:54.319Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/object-recognition/" service: "Zia Services" related: - Image-Moderation - API (/ja/api/code-reference/zia-services/image-moderation/#ImageModeration) -------------------------------------------------------------------------------- # Object Recognition Object Recognitionは、画像ファイル内の個々のオブジェクトを検出、特定、認識します。Zia Object Recognitionは、画像から80種類の異なるオブジェクトを識別できます。 詳細については、Object Recognitionヘルプページをご覧ください。 入力として._jpg_/._jpeg_または._png_ファイルを提供できます。リクエストとレスポンスの形式については、APIドキュメントを参照してください。 detectObject()メソッドは、画像内のオブジェクトを検出し識別するために使用されます。各オブジェクトの座標、種類、および各認識の信頼度スコアを返します。 #### サンプルコードスニペット <br> import com.zc.component.ml.ZCML; import com.zc.component.ml.ZCObjectDetectionData; import com.zc.component.ml.ZCObjectPoints; import java.io.File; File file = new File("{filePath}"); //ファイルの場所を指定する List objects = ZCML.getInstance().detectObjects(file); //画像内のオブジェクトを検出する for(ZCObjectDetectionData object : objects) { String objectType = object.getObjectType(); //オブジェクトの種類を取得する Double objConfidence = object.getConfidence(); //認識の信頼度スコアを取得する ZCObjectPoints objCoordinates = object.getObjectPoints(); //画像内のオブジェクトの座標を取得する } -------------------------------------------------------------------------------- title: "バーコードスキャナー" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してBarcode Scanner機能で特定のデータ形式をスキャンする方法について説明します" last_updated: "2026-06-10T06:04:54.319Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/barcode-scanner/" service: "Zia Services" related: - Barcode Scanner - API (/ja/api/code-reference/zia-services/barcode-scanner/#BarcodeScanner) -------------------------------------------------------------------------------- # Barcode Scanner Zia Barcode Scannerを使用すると、最も一般的に使用されるリニアおよび2Dバーコード形式をスキャンし、エンコードされたデータをデコードできます。Barcode Scannerは、Codabar、EAN-13、ITF、UPC-A、QR Codeなどの形式を検出できます。 詳細については、Barcode Scannerヘルプページをご覧ください。 入力ファイルとして、._jpg_/._jpeg_または._png_形式のファイルを提供できます。リクエストとレスポンスの形式については、APIドキュメントを参照してください。 setFormatを使用してバーコード形式を指定できます。形式としてALLを入力すると、Barcode Scannerが自動的に形式を検出します。デコードされた情報がレスポンスとして提供されます。 #### サンプルコードスニペット <br> import com.zc.component.ml.ZCBarcodeData; import com.zc.component.ml.ZCBarcodeFormat; import com.zc.component.ml.ZCBarcodeOptions; import com.zc.component.ml.ZCML; import java.io.File; File file = new File("{filePath}"); //ファイルパスを指定する ZCBarcodeOptions options = ZCBarcodeOptions.getInstance().setFormat(ZCBarcodeFormat.ALL); //フォーマットを指定する ZCBarcodeData barcodeResult =ZCML.getInstance().scanBarcode(file, options); //入力ファイルとオプションでscanBarcode()を呼び出す String content = barcodeResult.getContent(); //getContent()はデコードされたコンテンツを取得する ##### Identity Scanner -------------------------------------------------------------------------------- title: "顔の比較" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用して顔比較機能を使用する方法について説明します。" last_updated: "2026-06-10T06:04:54.321Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/identity-scanner/facial-comparison/" service: "Zia Services" related: - Facial Comparison - API (/ja/api/code-reference/zia-services/identity-scanner/facial-comparison/#FacialComparison) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、Zia AIドリブンのコンポーネントであり、さまざまな身分証明書や公式文書をスキャンして処理することで、個人やドキュメントに対する安全な本人確認を実行できます。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。 ## Facial Comparison Facial Comparison（E-KYCとも呼ばれる）は、Identity Scannerの一部であり、2つの異なる画像内の2つの顔を比較して、同一人物であるかどうかを判定します。これにより、身分証明書と既存の写真を比較することで、個人の本人確認を行うことができます。例えば、Aadhaarカードなどの写真付き身分証明書を、本人の現在の写真と比較することで、その真正性を検証できます。 注: Identity ScannerのDocument Processing機能はインドのユーザーにのみ関連していますが、Facial ComparisonのAPIおよびSDKツールはグローバルユーザーが利用できます。ただし、CatalystコンソールからのFacial ComparisonまたはE-KYCへのアクセスとテストは、IN DCのユーザーのみに制限されています。 サンプルコードに示すように、ソース画像とクエリ画像の両方の画像ファイルのパスを指定することで、顔比較を実行できます。compareFace()メソッドがこれらの画像を処理します。 注: 身分証明書の画像または個人の写真のいずれかをソースまたはクエリ画像としてマークできます。これは結果に影響しません。 許可されるファイル形式: _.webp_, _.jpeg_, _.png_ ファイルサイズ制限: 10 MB 比較結果は、顔が一致する場合はtrueに、一致しない場合はfalseに設定されます。結果には、処理の精度を判定する0から1の範囲の信頼度スコアも含まれます。比較で50%（0.5）を超える信頼度スコアが得られた場合にのみ、結果がtrueに設定されます。 #### サンプルコードスニペット <br> import com.catalyst.advanced.CatalystAdvancedIOHandler; import com.zc.component.ml.ZCFaceComparisonData; import com.zc.component.ml.ZCML; import java.io.File; File sourceImage= new File("/Users/amelia-421/Desktop/source.webp"); //ファイルパスを指定する File queryImage= new File("/Users/amelia-421/Desktop/query.webp"); //ファイルパスを指定する ZCFaceComparisonData data = ZCML.getInstance().compareFace(sourceImage,queryImage ); Double confidence = data.getConfidence(); //信頼度スコアを取得する boolean matched= data.getMatched(); //結果をboolean値として取得する -------------------------------------------------------------------------------- title: "Aadhaar" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してAADHAARドキュメント処理機能を使用する方法について説明します。" last_updated: "2026-06-10T06:04:54.321Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/identity-scanner/aadhaar/" service: "Zia Services" related: - Aadhaar - API (/ja/api/code-reference/zia-services/identity-scanner/aadhaar/#Aadhaar) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、Zia AIドリブンのコンポーネントであり、さまざまな身分証明書や公式文書をスキャンして処理することで、個人やドキュメントに対する安全な本人確認を実行できます。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。 ## Aadhaar AADHAARモデルは、Document Processing機能の一部であり、インドのAadhaarカードを本人確認書類として処理できます。これにより、高度なOCR技術を使用してインドのAadhaarカードからデータフィールドを抽出できます。レスポンスは、Aadhaarカードから認識されたパラメータと、各認識の精度を判定する信頼度スコアを返します。 注: Document Processingはインドのユーザーにのみ関連しており、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SA、またはCAデータセンターからアクセスしているユーザーには利用できません。他のDCからのインド国外のユーザーは、汎用OCRコンポーネントにアクセスしてテキストコンテンツを読み取り、処理できます。 以下のコードに示すように、aadhaarFrontおよびaadhaarBackキーを使用して、Aadhaarカードの表面と裏面の画像ファイルのパスを指定する必要があります。 注: Aadhaarカードに含まれる言語を渡すオプションは非推奨になりました。Identity Scannerは、Aadhaarカードの言語を自動的に識別して処理します。Java SDKコードスニペットはまもなく更新される予定です。 以下のコードに示すように、一時的に言語を渡すことができます。英語と関連する地域言語を渡す必要があります。例えば、タミル・ナードゥ州出身の場合、言語としてtamとengを渡す必要があります。言語と言語コードの一覧は、APIドキュメントで確認できます。 許可されるファイル形式: _.webp_, _.jpeg_, _.png_, _.bmp_, _.tiff_, _.pdf_<br /> ファイルサイズ制限: 15 MB 注: 変数は以下の順序でのみ宣言する必要があります: aadhaarFront、aadhaarBack、languageCode レスポンスには、カード所有者の名前、住所、性別、Aadhaarカード番号など、Aadhaarカードで認識されたパラメータがそれぞれのキーに割り当てられて含まれます。レスポンスには、認識された各値に対して0から1の範囲の信頼度スコアも表示されます。 #### サンプルコードスニペット <br> import com.zc.component.ml.ZCContent; import com.zc.component.ml.ZCLine; import com.zc.component.ml.ZCML; import com.zc.component.ml.ZCParagraph; import java.io.File; File aadhaarFront = new File("/Users/amelia-421/Desktop/myAadhaar1.webp"); //ファイルパスを指定する of the front side image of the Aadhaar card File aadhaarBack = new File("/Users/amelia-421/Desktop/myAadhaar2.webp"); //ファイルパスを指定する of the back side image of the Aadhaar card String languageCode = "eng,tam"; //言語を設定する ZCContent ocrContent = ZCML.getInstance().getContentForAadhaar(aadhaarFront,aadhaarBack,languageCode); //ファイルオブジェクトでgetContent()を呼び出して、ZCContentオブジェクトで検出されたテキストを取得する //個別の段落を取得する List paragraphs = ocrContent.getParagraphs(); for(ZCParagraph paragraph : paragraphs) { //段落内の個別の行を取得する List paraLines = paragraph.lines; for(ZCLine line : paraLines) { //行内の個別の単語を取得する String words = line.words; String text = line.text; //生の行テキスト } String text = paragraph.text; //段落の生テキストを返す } String text = ocrContent.text; //画像の生テキストを返す -------------------------------------------------------------------------------- title: "PAN" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してPANドキュメント処理機能を使用する方法について説明します" last_updated: "2026-06-10T06:04:54.321Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/identity-scanner/pan/" service: "Zia Services" related: - PAN - API (/ja/api/code-reference/zia-services/identity-scanner/pan/#PAN) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、Zia AIドリブンのコンポーネントであり、さまざまな身分証明書や公式文書をスキャンして処理することで、個人やドキュメントに対する安全な本人確認を実行できます。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。 ## PAN PANモデルは、Document Processing機能の一部であり、インドのPANカードを本人確認書類として処理できます。これにより、高度なOCR技術を使用してPANカードからデータフィールドを抽出し、レスポンスでPANカードから認識されたパラメータを返すことができます。 注: Document Processingはインドのユーザーにのみ関連しており、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SA、またはCAデータセンターからアクセスしているユーザーには利用できません。他のDCからのインド国外のユーザーは、汎用OCRコンポーネントにアクセスしてテキストコンテンツを読み取り、処理できます。 以下のコードに示すように、PANカードの表面の画像ファイルのパスを指定する必要があります。 許可されるファイル形式: _.webp_, _.jpeg_, _.png_<br /> ファイルサイズ制限: 15 MB ZCOCRModelTypeを使用してモデルタイプをPANとして指定する必要があります。PANモデルは、デフォルトで英語のテキストのみを処理できます。他の言語はサポートされていません。 レスポンスには、名、姓、生年月日、PANカード番号など、PANカードから抽出されたパラメータがそれぞれのキーに割り当てられて含まれます。 #### サンプルコードスニペット <br> import java.sql.Date; import com.zc.component.ml.ZCContent; import com.zc.component.ml.ZCML; import com.zc.component.ml.ZCOCRModelType; import com.zc.component.ml.ZCOCROptions; import com.zc.component.ml.ZCPanData; import java.io.File; File file = new File("/Users/amelia-421/Desktop/pan.webp"); //ファイルパスを指定する ZCOCROptions options = ZCOCROptions.getInstance().setModelType(ZCOCRModelType.PAN); //モデルタイプを設定する ZCContent ocrContent = ZCML.getInstance().getContent(file, options); //ファイルオブジェクトでgetContent()を呼び出して、ZCContentオブジェクトで検出されたテキストを取得する ZCPanData panData = ocrContent.getPanData(); //このメソッドはPANデータを取得する //処理された画像から名、姓、PAN詳細、生年月日などの個別要素を取得する String firstName = panData.getFirstName(); String lastName = panData.getLastName(); String pan = panData.getPan(); Date dob = panData.getDob(); -------------------------------------------------------------------------------- title: "通帳" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してPASSBOOKドキュメント処理機能を使用する方法について説明します" last_updated: "2026-06-10T06:04:54.321Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/identity-scanner/passbook/" service: "Zia Services" related: - Passbook - API (/ja/api/code-reference/zia-services/identity-scanner/passbook/#Passbook) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、Zia AIドリブンのコンポーネントであり、さまざまな身分証明書や公式文書をスキャンして処理することで、個人やドキュメントに対する安全な本人確認を実行できます。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。 ## Passbook PASSBOOKモデルは、Document Processing機能の一部であり、インドの銀行通帳を金融または本人確認書類として処理できます。これにより、OCR技術を使用して通帳からデータフィールドを抽出し、レスポンスでパラメータを取得できます。 注: Document Processingはインドのユーザーにのみ関連しており、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SA、またはCAデータセンターからアクセスしているユーザーには利用できません。他のDCからのインド国外のユーザーは、汎用OCRコンポーネントにアクセスしてテキストコンテンツを読み取り、処理できます。 Passbookモデルは、11のインド言語と追加の8つの国際言語をサポートしています。言語と言語コードの一覧は、APIドキュメントで確認できます。 以下のコードに示すように、通帳の表紙ページの画像のパスを指定する必要があります。 許可されるファイル形式: _.webp_, _.jpeg_, _.png_, _.bmp_, _.tiff_, _.pdf_<br /> ファイルサイズ制限: 15 MB ZCOCRModelTypeを使用してモデルタイプをPASSBOOKとして指定する必要があります。また、オプションでsetLanguageCode()を使用して言語を指定することもできます。指定されていない場合、デフォルトの言語として英語が使用されます。 レスポンスには、銀行名、支店、住所、口座番号など、通帳から認識された銀行の詳細と口座の詳細が含まれます。抽出された情報フィールドは、それぞれのキーに割り当てられます。レスポンスには、その口座でRTGS、NEFT、およびIMPSが有効になっているかどうかも表示されます。 注: Identity Scannerは、通帳に含まれる言語に関係なく、英語でのみレスポンスを返します。 #### サンプルコードスニペット <br> import com.zc.component.ml.ZCContent; import com.zc.component.ml.ZCLine; import com.zc.component.ml.ZCML; import com.zc.component.ml.ZCOCRModelType; import com.zc.component.ml.ZCOCROptions; import com.zc.component.ml.ZCParagraph; import java.io.File; File file = new File("/Users/amelia-421/Desktop/MyPassbook.webp"); //ファイルパスを指定する ZCOCROptions options = ZCOCROptions.getInstance().setModelType(ZCOCRModelType.PASSBOOK) .setLanguageCode("tam"); //モデルタイプを設定する and language ZCContent ocrContent = ZCML.getInstance().getContent(file, options); //ファイルオブジェクトでgetContent()を呼び出して、ZCContentオブジェクトで検出されたテキストを取得する //個別の段落を取得する List paragraphs = ocrContent.getParagraphs(); for(ZCParagraph paragraph : paragraphs) { //段落内の個別の行を取得する List paraLines = paragraph.lines; for(ZCLine line : paraLines) { //行内の個別の単語を取得する String words = line.words; String text = line.text; //生の行テキスト } String text = paragraph.text; //段落の生テキストを返す } String text = ocrContent.text; //画像の生テキストを返す -------------------------------------------------------------------------------- title: "小切手" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してChequeドキュメント処理機能を使用する方法について説明します。" last_updated: "2026-06-10T06:04:54.321Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/identity-scanner/cheque/" service: "Zia Services" related: - Cheque - API (/ja/api/code-reference/zia-services/identity-scanner/cheque/#Cheque) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、Zia AIドリブンのコンポーネントであり、さまざまな身分証明書や公式文書をスキャンして処理することで、個人やドキュメントに対する安全な本人確認を実行できます。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。 ## Cheque CHEQUEモデルは、Document Processing機能の一部であり、インドの銀行小切手を本人確認書類として処理できます。これにより、高度なOCR技術を使用して小切手からデータフィールドを抽出し、レスポンスを通じて小切手から認識されたパラメータを取得できます。 注: Document Processingはインドのユーザーにのみ関連しており、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SA、またはCAデータセンターからアクセスしているユーザーには利用できません。他のDCからのインド国外のユーザーは、汎用OCRコンポーネントにアクセスしてテキストコンテンツを読み取り、処理できます。 以下のコードに示すように、小切手帳の表面の画像ファイルのパスを指定する必要があります。CHEQUEモデルは、デフォルトで英語のテキストのみを処理できます。他の言語はサポートされていません。 許可されるファイル形式: _.webp_, _.jpeg_, _.png_<br /> ファイルサイズ制限: 15 MB setModelType()を使用してモデルタイプをCHEQUEとして指定する必要があります。 注: ZiaはCTS-2010形式の小切手のみを処理します。 レスポンスには、金額、銀行名、支店名、口座番号、IFSCコードなど、小切手から抽出されたパラメータがそれぞれのキーに割り当てられて含まれます。 #### サンプルコードスニペット <br> import java.sql.Date; import com.zc.component.ml.ZCChequeData; import com.zc.component.ml.ZCContent; import com.zc.component.ml.ZCML; import com.zc.component.ml.ZCOCRModelType; import com.zc.component.ml.ZCOCROptions; import java.io.File; File file = new File("/Users/amelia-421/Desktop/cheque.webp"); //ファイルパスを指定する ZCOCROptions options = ZCOCROptions.getInstance().setModelType(ZCOCRModelType.CHEQUE); //モデルタイプを設定する ZCContent ocrContent = ZCML.getInstance().getContent(file, options); //ファイルオブジェクトでgetContent()を呼び出して、ZCContentオブジェクトで検出されたテキストを取得する ZCChequeData chequeData = ocrContent.getChequeData(); //このメソッドは小切手データを取得する //処理された画像から口座番号、IFSCコード、銀行名、支店、金額、取引日などの個別要素を取得する String accountNumber = chequeData.getAccountNumber(); String ifsc = chequeData.getIfsc(); String bankName = chequeData.getBankName(); String branchName = chequeData.getBranchName(); Long amount = chequeData.getAmount(); Date date = chequeData.getDate(); ##### Text Analytics -------------------------------------------------------------------------------- title: "感情分析" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用して感情分析機能を使用する方法について説明します。" last_updated: "2026-06-10T06:04:54.322Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/text-analytics/sentiment-analysis/" service: "Zia Services" related: - Sentiment Analysis - API (/ja/api/code-reference/zia-services/text-analytics/sentiment-analysis/#SentimentAnalysis) -------------------------------------------------------------------------------- # Sentiment Analysis Zia Sentiment Analysisは、Text Analyticsの一部であり、テキストコンテンツを処理してメッセージのトーンとそれを通じて伝えられる感情を認識します。テキスト内の各文を分析して、そのトーンがpositive、negative、またはneutralのいずれであるかを判定します。次に、各文で認識された感情に基づいて、テキスト全体のトーンをこれら3つの感情のいずれかとして判定します。 レスポンスには、分析の精度を示すために、各文で検出された感情の信頼度スコアも返されます。信頼度スコアは0から1の範囲です。全体的な分析の信頼度スコアも返されます。 1回のリクエストで最大1500文字のテキストブロックを入力として渡すことができます。また、テキストのオプションのキーワードを渡すこともできます。これにより、Sentiment Analysisはこれらのキーワードを含む文のみを処理し、その感情を判定します。他の文は無視されます。 入力テキストは、ZCSentimentAnalysisDataクラスのgetSentimentAnalysis()関数に渡されます。コードには、各文の感情と信頼度スコア、および全体的なスコアを取得するステートメントが含まれています。 #### サンプルコードスニペット <br> import org.json.simple.JSONArray; import com.catalyst.advanced.CatalystAdvancedIOHandler; import com.zc.component.ml.ZCML; import com.zc.component.ml.ZCSentenceAnalytics; import com.zc.component.ml.ZCSentimentAnalysisData; import com.zc.component.ml.ZCSentimentAnalysisDetails; import com.zc.component.ml.ZCSentimentConfidenceScore; import java.io.File; JSONArray textArray = new JSONArray(); textArray.add("ZylkerDB is one of their best products. I've been Zylker's customer for over a decade now, and I've always had a great experience with them."); //処理する入力テキスト JSONArray keywords = new JSONArray(); keywords.add("Zylker"); //オプションのキーワード（これらのキーワードを含む文のみを処理する場合） List listOfSentimentAnalysisData = ZCML.getInstance().getSentimentAnalysis(textArray,keywords); //入力テキストが渡される ZCSentimentAnalysisData sentimentAnalysisData = listOfSentimentAnalysisData.get(0); List SentimentAnalysisDetails = sentimentAnalysisData .getSentimentAnalysisDetails(); for (ZCSentimentAnalysisDetails sentimentAnalysis : SentimentAnalysisDetails) { String sentiment = sentimentAnalysis.getDocumentSentiment(); //テキスト全体のセンチメントを取得する double overallScore = sentimentAnalysis.getOverallScore(); //全体分析の信頼度スコアを取得する List listOfSentenceAnalytics = sentimentAnalysis.getSentenceAnalytics(); //各文のセンチメントを取得する ZCSentenceAnalytics sentenceAnalytic = listOfSentenceAnalytics.get(0); String sentenceSentiment = sentenceAnalytic.getSentiment(); String sentence = sentenceAnalytic.getSentence(); ZCSentimentConfidenceScore sentenceLevelConfidenceScore = sentenceAnalytic.getConfidenceScore(); //各文の分析の信頼度スコアを取得する } -------------------------------------------------------------------------------- title: "固有表現認識" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用して固有表現認識機能を使用する方法について説明します。" last_updated: "2026-06-10T06:04:54.322Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/text-analytics/named-entity-recognition/" service: "Zia Services" related: - Named Entity Recognition - API (/ja/api/code-reference/zia-services/text-analytics/named-entity-recognition/#NamedEntityRecognition) -------------------------------------------------------------------------------- # Named Entity Recognition Zia Named Entity Recognitionは、Text Analyticsの一部であり、テキストコンテンツを処理してキーワードを抽出し、さまざまなカテゴリにグループ化します。例えば、テキスト内の単語が組織名、人名、または日付であることを判定し、適切なカテゴリに追加できます。NERで認識されるすべてのカテゴリの一覧は、こちらを参照してください。 レスポンスは、テキスト内で認識されたすべてのエンティティの配列と、それらが属するカテゴリを示すタグを返します。また、精度を示すために、各分類の信頼度スコアがパーセント値で含まれます。レスポンスには、開始インデックスと終了インデックスを通じてテキスト内のエンティティの位置も返されます。 以下に示すように、1回のリクエストで最大1500文字のテキストブロックを入力として渡すことができます。テキストはgetNERPrediction()に渡されます。コードには、エンティティ、そのタグ、位置、および信頼度スコアを取得するステートメントが含まれています。 #### サンプルコードスニペット <br> import org.json.simple.JSONArray; import com.zc.component.ml.ZCML; import com.zc.component.ml.ZCNERData; import com.zc.component.ml.ZCNERDetails; import java.io.File; JSONArray textArray = new JSONArray(); textArray.add("Zoho Corporation, is an Indian multinational technology company that makes web-based business tools.It is best known for Zoho Office Suite. The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton, California."); //処理する入力テキスト List listOfNERData = ZCML.getInstance().getNERPrediction(textArray); //入力テキストを渡す List nerDetails = listOfNERData.get(0).getNERList(); String token = nerDetails.get(0).getToken(); //エンティティを認識する String tag = nerDetails.get(0).getNERTag(); //各エンティティのカテゴリを取得する double confidenceScore = nerDetails.get(0).getConfidenceScore(); //各分類の信頼度スコアを取得する int startIndex = nerDetails.get(0).getStartIndex(); //各エンティティの開始インデックスを取得する int endIndex = nerDetails.get(0).getEndIndex(); //各エンティティの終了インデックスを取得する -------------------------------------------------------------------------------- title: "キーワード抽出" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してキーワード抽出機能を使用する方法について説明します。" last_updated: "2026-06-10T06:04:54.322Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/text-analytics/keyword-extraction/" service: "Zia Services" related: - Keyword Extraction - API (/ja/api/code-reference/zia-services/text-analytics/keyword-extraction/#KeywordExtraction) -------------------------------------------------------------------------------- # Keyword Extraction Zia Keyword Extractionは、Text Analyticsの一部であり、テキストコンテンツを処理してテキストのハイライトを抽出します。抽出された用語は、KeywordsとKeyphrasesの2つのカテゴリにグループ化されます。これらのハイライトは、テキストの簡潔な要約を提供し、テキスト全体の抽象化を行います。 レスポンスには、テキストから抽出されたキーワードの配列と、キーフレーズの別の配列が含まれます。 以下に示すように、1回のリクエストで最大1500文字のテキストブロックを入力として渡すことができます。テキストはgetKeywordExtraction()に渡されます。キーワードとキーフレーズは個別のリストとして取得されます。 #### サンプルコードスニペット <br> import org.json.simple.JSONArray; import com.zc.component.ml.ZCKeywordExtractionData; import com.zc.component.ml.ZCML; import java.io.File; JSONArray textArray = new JSONArray(); textArray.add("Zoho Corporation, is an Indian multinational technology company that makes web-based business tools. It is best known for Zoho Office Suite. The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton, California."); //処理する入力テキスト List listOfKeywordExtractionData = ZCML.getInstance().getKeywordExtraction(textArray); //テキストが渡される ZCKeywordExtractionData keywordExtractionData = listOfKeywordExtractionData.get(0); List keywordsList = keywordExtractionData.getKeywords(); //キーワードを取得する List keyphrasesList = keywordExtractionData.getKeyphrases(); //キーフレーズを取得するため -------------------------------------------------------------------------------- title: "すべてのテキスト解析" description: "このページでは、Javaアプリケーションでサンプルコードスニペットを使用してテキスト分析機能を使用する方法について説明します。" last_updated: "2026-06-10T06:04:54.322Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/zia-services/text-analytics/all-text-analytics/" service: "Zia Services" related: - All Text Analytics - API (/ja/api/code-reference/zia-services/text-analytics/all-text-analytics/#AllTextAnalytics) -------------------------------------------------------------------------------- # All Text Analytics Text Analyticsは全体として、前のセクションで説明した3つの機能すべての組み合わせを含みます: Sentiment Analysis、Named Entity Recognition、およびKeyword Extraction。特定のテキストブロックに対して3つのアクションすべてを実行し、テキストのトーン、認識されたエンティティの分類、およびテキストの要旨を提供するキーワードとフレーズを取得できます。 以下に示すように、1回のリクエストで最大1500文字のテキストブロックを入力として渡すことができます。テキストはgetTextAnalytics()に渡されます。また、オプションのキーワードを渡して、それらのキーワードを含む文のみに対してSentiment Analysisを実行することもできます。 レスポンスには、各テキスト分析機能の結果が含まれます。それぞれの機能と応答の詳細については、各機能のページを参照してください。 #### サンプルコードスニペット <br> import org.json.simple.JSONArray; import com.zc.component.ml.ZCKeywordExtractionData; import com.zc.component.ml.ZCML; import com.zc.component.ml.ZCNERData; import com.zc.component.ml.ZCSentimentAnalysisData; import com.zc.component.ml.ZCTextAnalyticsData; import java.io.File; JSONArray textArray = new JSONArray(); textArray.add("Zoho Corporation, is an Indian multinational technology company that makes web-based business tools. It is best known for Zoho Office Suite. The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton,California."); //処理する入力テキスト JSONArray keywords = new JSONArray(); keywords.add("Zoho"); //センチメント分析のオプションキーワード List listOfTextAnalyticsData = ZCML.getInstance().getTextAnalytics(textArray,keywords); //テキストとキーワードが渡される ZCTextAnalyticsData textAnalyticsData = listOfTextAnalyticsData.get(0); ZCKeywordExtractionData keywordExtractionData = textAnalyticsData.getKeywordExtractionData(); //テキストに対してキーワード抽出を実行する Z CNERData nerData = textAnalyticsData.getNERData(); //テキストに対してNERを実行する ZCSentimentAnalysisData sentimentAnalysisData = textAnalyticsData.getSentimentAnalysisData(); //テキストに対してセンチメント分析を実行する #### 一般 ##### プロジェクト -------------------------------------------------------------------------------- title: "プロジェクト初期化時にキャッシュされたプロジェクトデータの取得" description: "このページでは、プロジェクト初期化時にキャッシュされたプロジェクトデータを取得する方法について説明します。" last_updated: "2026-06-10T06:04:54.323Z" source: "https://docs.catalyst.zoho.com/ja/sdk/java/v1/general/projects/retrieve-project-cached-data/" service: "All Services" related: - Projects - API (/ja/api/code-reference/general/projects/create-new-project/#CreateNewProject) - Initialize Projects (/ja/cli/v1/initialize-resources/initialize-new-project/) -------------------------------------------------------------------------------- # プロジェクト初期化時にキャッシュされたプロジェクトデータの取得 Catalystでは、初期化時にプロジェクトデータをアプリオブジェクトとしてバックエンドにキャッシュできます。 以下のSDKスニペットは、getProject()メソッドを使用して、いつでもキャッシュされたアプリオブジェクトを取得する方法を示しています。 #### サンプルコードスニペット <br> import com.zc.common.ZCProject; import com.zc.component.zcql.ZCQL; ZCProject userProject = ZCProject.getProject("user"); ZCQL.getInstance(userProject).executeQuery("select * from test"); // 指定したカスタムスコープでZCQLオブジェクトを作成するにはgetInstance()メソッドを使用する必要がある ## Node JS ### v2 -------------------------------------------------------------------------------- title: "概要" description: "Node.js SDKの概要" last_updated: "2026-06-10T06:04:54.324Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/overview/" service: "All Services" related: - Catalyst Java SDK (/ja/sdk/java/v1/overview/) - Catalyst Web SDK (/ja/sdk/web/v4/overview/) - API Code Reference (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) - Catalyst Functions (/ja/serverless/help/functions/introduction) -------------------------------------------------------------------------------- # Node JS SDK ## 概要 Node JS SDKには、Catalystのコンポーネントやサービスにアクセスするために必要なメソッドがすべて含まれています。動作が事前に定義されたCatalystコンポーネントを宣言・定義することができます。たとえば、各CatalystコンポーネントにはSDK内に対応するNodeJSオブジェクトがあり、API相当の操作はNodeJSのメソッドとして呼び出されます。 ### プロジェクトにCatalyst SDKを組み込む CLIでNode.js関数を初期化する際に**install dependencies**オプションを選択した場合、Node.js SDKは自動的に生成されるサンプルボイラープレートコードに含まれます。ただし、CLIで関数のルートディレクトリから以下のコマンドを実行して、手動でプロジェクトに組み込むこともできます： npm install zcatalyst-sdk-node 以下の方法で、サポートされている最新バージョンをインストールすることもできます： npm install zcatalyst-sdk-node@2.5.0 <br> 注意: 2.5.0より前のすべてのバージョンの`zcatalyst-sdk-node`パッケージ（ベータリリースを含む）は非推奨になりました。アプリケーションですべてのNode.jsメソッドに完全にアクセスできるように、最新バージョンにアップグレードしてください。 ### SDKの初期化 Catalyst Node.js SDKを初期化すると、オブジェクトが返されます。この返されたオブジェクトを通じて、現在のプロジェクトのCatalystコンポーネントにアクセスできます。異なるタイプの関数に対する初期化方法は以下の通りです。 var catalyst = require('zcatalyst-sdk-node'); module.exports = (req, res) => { var app = catalyst.initialize(req); //このapp変数はCatalystコンポーネントにアクセスするために使用されます。 //コードサンプルについてはSDKドキュメントを参照してください。 //ビジネスロジックをここに記述する } var catalyst = require('zcatalyst-sdk-node'); const express = require('express'); const expressApp = express(); expressApp.get('/',(req,res)=> { var app = catalyst.initialize(req); //このapp変数はCatalystコンポーネントにアクセスするために使用されます。 //コードサンプルについてはSDKドキュメントを参照してください。 //ビジネスロジックをここに記述する }); module.exports=expressApp; const catalyst = require('zcatalyst-sdk-node'); module.exports = (context, basicIO) => { const app = catalyst.initialize(context); //このapp変数はCatalystコンポーネントにアクセスするために使用されます。 //コードサンプルについてはSDKドキュメントを参照してください。 //ビジネスロジックをここに記述する } const catalyst = require('zcatalyst-sdk-node'); module.exports = (event, context) => { const app = catalyst.initialize(context); //このapp変数はCatalystコンポーネントにアクセスするために使用されます。 //コードサンプルについてはSDKドキュメントを参照してください。 //ビジネスロジックをここに記述する } const catalyst = require('zcatalyst-sdk-node'); module.exports = (cronDetails, context) => { const app = catalyst.initialize(context); //このapp変数はCatalystコンポーネントにアクセスするために使用されます。 //コードサンプルについてはSDKドキュメントを参照してください。 //ビジネスロジックをここに記述する } これで、初期化された変数を使用してコンポーネントにアクセスできます。 ### スコープを使用したSDKの初期化 Catalystでは、以下のスコープを使用してプロジェクトのSDKを初期化できます： * **Admin**: すべてのコンポーネントとそれぞれの機能に制限なくアクセスできます。たとえば、Data Storeに完全にアクセスし、読み取り、書き込み、削除などのすべての操作を実行できます。 * **User**: コンポーネントや特定の機能へのアクセスを制限できます。たとえば、Data Storeに対して読み取りアクセスのみを提供できます。 注意: * スコープを使用してプロジェクトを初期化することは必須ではありません。デフォルトでは、初期化されたプロジェクトにはAdmin権限が付与されます。 * ビジネスロジックを構築する際には、適切なスコープでCatalyst SDKを初期化してください。スコープに定義した権限がエンドユーザーの操作を制御します。 * スコープは、Data Store、File Store、およびZCQLに関連する操作にのみ適用されます。 * ビジネスロジックの構築方法に応じて、エンドユーザーがAdminまたはUser操作を実行できるかを決定できます。これは、エンドユーザーがCatalyst Authenticationでアプリケーションにサインアップする際に割り当てられるロールに基づいて決定されます。ロールの権限は、Data StoreおよびFile storeのScopes & Permissionsセクションで設定できます。 以下のSDKスニペットにより、*Admin*または*User*スコープを使用してSDKを初期化し、Data Storeで**SELECT**クエリを実行できます： * **AdminスコープでのSDK初期化** const catalyst = require('zcatalyst-sdk-node'); module.exports = async (req, res) => { const app = catalyst.initialize(req); const adminApp = catalyst.initialize(req, { scope: 'admin'}); // 管理者スコープのCatalystアプリオブジェクト await adminApp.zcql().executeZCQLQuery('select * from test'); } * **UserスコープでのCatalystプロジェクト初期化** const catalyst = require('zcatalyst-sdk-node'); module.exports = async (req, res) => { const app = catalyst.initialize(req); const userApp = catalyst.initialize(req, { scope: 'user'}); // ユーザースコープのCatalystアプリオブジェクト await userApp.zcql().executeZCQLQuery('select * from test'); } -------------------------------------------------------------------------------- title: "Node.js SDKのアップグレード" description: "このページでは、コード内のNode.js SDKをサポートされている最新バージョンにアップグレードする手順について説明します" last_updated: "2026-06-10T06:04:54.324Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/upgrade-sdk/" service: "All Services" related: - Catalyst Java SDK (/ja/sdk/java/v1/overview/) - Catalyst Python SDK (/ja/sdk/web/v4/overview/) - API Code Reference (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) - Catalyst Functions (/ja/serverless/help/functions/introduction) -------------------------------------------------------------------------------- # Node.js SDKのアップグレード Catalystは、できる限り簡単にアプリケーションをコーディングできるよう、最新で関連性の高い安全なSDKパッケージを常に提供するよう努めています。また、テクノロジーのアップグレードに基づいてSDKサポートもアップグレードしています。つまり、Node.jsの新しいバージョンがリリースされると、CatalystはSDKツールキットにそれを実装します。 これは、Catalystが最高のコーディングサポートを提供するために、随時SDKバージョンをアップグレードすることを意味します。リリースノートセクションからCatalyst SDKの最新の開発状況を常に確認し、SDKパッケージを最新バージョンにアップグレードすることを強くお勧めします。*バグ修正*がある場合も、**リリースノート**で公開します。 注意: 非推奨の理由により即時アップグレードが必要な場合は、必要なアップグレードを実行するようにメールで適時お知らせします。一般的に、SDKを常に最新バージョンにアップグレードすることを強く推奨します。 ### SDKをアップグレードする手順 Node.js SDKをアップグレードするには、2つの方法があります： 1. npm updateコマンドを使用する。 2. npm installコマンドを使用する。 #### npm updateコマンドの使用 1. ターミナルを起動し、Node.js関数のソースディレクトリに移動します。 たとえば、ディレクトリ**/Users/user/apps/petsConglomerate**に「*Pets Conglomerate*」というアプリケーションがあるとします。このアプリケーションに「*dogs_spotted*」という関数がある場合、関数のソースディレクトリに移動する必要があります。パスは次のようになります：**/Users/user/apps/petsConglomerate/functions/dogs_spotted** 2. 以下のコマンドを実行します npm update zcatalyst-sdk-node これにより必要な更新が実行され、zcatalyst-sdk-nodeの最新バージョンが使用できるようになります。 注意: プロジェクト内に存在するすべてのNode.js関数に対して、同じ手順を適用する必要があります。 #### npm installコマンドの使用 注意: npm installコマンドは、新しいパッケージのインストールと既存のパッケージの更新の両方に使用できます。 1. ターミナルを起動し、Node.js関数のソースディレクトリに移動します。 たとえば、ディレクトリ**/Users/user/apps/petsConglomerate**に「*Pets Conglomerate*」というアプリケーションがあるとします。このアプリケーションに「*dogs_spotted*」という関数がある場合、関数のソースディレクトリに移動する必要があります。パスは次のようになります：**/Users/user/apps/petsConglomerate/functions/dogs_spotted** 2. 以下のコマンドを実行します npm install -save zcatalyst-sdk-node@latest<br /> 注意: * @latestタグは任意です。ただし、インストールを実行する際に含めることを推奨します。 * プロジェクト内に存在するすべてのNode.js関数に対して、同じ手順を適用する必要があります。 ### 特定のパッケージをインストールする 特定のSDKバージョンのパッケージをインストールするには： 1. ターミナルを起動し、Node.js関数のソースディレクトリに移動します。 2. 必要なSDKバージョンを指定して、以下のコマンドを実行します npm install -save zcatalyst-sdk-node@2.5.1<br /><br /> 注意: 特定のバージョンではなく、常にSDKの最新かつ安定したバージョンをインストールすることを推奨します。 -------------------------------------------------------------------------------- title: "サードパーティアプリケーションへのSDK統合" last_updated: "2026-06-10T06:04:54.324Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/integrate-sdk-in-third-party-apps/" service: "All Services" related: - Catalyst Environments (/ja/deployment-and-billing/environments/introduction/) - Catalyst Cloud Scale Authentication (/ja/cloud-scale/help/authentication/introduction/) - Catalyst Cloud Scale Stratus (/ja/cloud-scale/help/stratus/introduction/) -------------------------------------------------------------------------------- # サードパーティアプリケーションへのCatalyst Node.js SDK統合 Catalyst Node.js SDKのメソッドを、Catalyst環境の外部にデプロイされたアプリケーションに統合して使用できます。たとえば、Vercelでホストされ、Flaskバックエンド（Catalyst外で稼働）を使用するReactアプリがCatalyst Cloud Scale Stratusにドキュメントをアップロードしたり、Amazon Web Services EC2で実行されるデータパイプラインがCatalyst Cloud Scale ZCQLクエリを使用してCatalyst Cloud Scale Data Storeに顧客データをプッシュしたりすることが、それぞれのNode.js SDK操作を使用して可能です。 これらは、外部アプリケーションがCatalystプラットフォーム内にデプロイされることなく、Catalystコンポーネントと安全にやり取りできる一般的なユースケースのほんの一例です。 Catalyst Node.js SDKを外部アプリケーションと統合するためのコードスニペットを用意しています。ただし、アプリケーションにコードを実装する前に、以下の前提条件をご確認ください。 ### SDK統合の前提条件 Catalyst Node.js SDKを外部アプリケーションと統合するには、以下の情報が必要です： * **Project ID:** Catalystプロジェクトの一意の識別子です。 * **ZAID (Zoho Account ID):** プロジェクトをCatalyst環境（開発または本番）にリンクするためにCatalystが割り当てる一意のポータル識別子です。 * **Environment:** Catalystプロジェクトのターゲット環境（開発または本番）です。 * **OAuthクレデンシャル:** 外部アプリケーションがCatalystのセルフクライアントポータルを介してCatalystコンポーネントにアクセスするための認証・認可に必要です。以下が必要になります： 1. Client ID 2. Client Secret 3. Refresh Token これらの値を取得した後、アプリケーションへのNode.js SDKの統合に進むことができます。 <br> ### 統合手順 それでは、各値の取得方法とコードスニペットでの設定方法を見ていきましょう。 以下に示す手順に従ってください： 1. **Catalystコンソールでプロジェクトを作成する:** コンソールで、このヘルプページに記載されている手順に従って、新しいCatalystプロジェクトを作成できます。 2. **Project IDを取得する:** プロジェクトを作成したら、**Project ID**を控えておく必要があります。Project IDはプロジェクト作成時に自動的に生成されるプロジェクトの一意のIDです。 Catalystコンソールの右上にある**Settings**アイコンをクリックして確認できます。 **Settings**画面で、**Project Settings**に移動し、**General**を選択します。以下のスクリーンショットに示すように、このセクションからProject IDを確認して控えておくことができます。 <br> 3. **ZAIDを取得する:** このセクションで提供されるコードスニペットに、プロジェクトの**ZAID**を含める必要があります。**ZAID**は、プロジェクトを必要なCatalyst環境（開発または本番）にリンクするためにCatalystが割り当てる一意のポータル識別子です。 Catalyst環境の詳細はこちら。 ZAIDを取得するには、Catalyst CloudScale Authenticationコンポーネントのセットアップが必須です。ただし、アプリケーションの認証フローでの使用は任意です。ZAIDを取得するには： i. コンソールでCatalyst CloudScaleサービスに移動し、**Security & Identity**の下で**Authentication**を選択します。 <br> ii. Native Catalyst Authenticationをセットアップする必要があります。Catalystが認証プロセス全体を管理するため、追加のコーディングやインフラストラクチャ管理は不要です。 iii. **Set Up**をクリックします。 <br> iv. **Hosted authentication**タイプを選択します。これにより、アプリケーションの専用ページにログイン要素をホストできます。コンソールから認証を設定・デザインでき、Catalystがアプリケーション用にレンダリングし、すべてのバックエンド要件を処理します。 <br> v. Public Signupオプションを有効にして、ログインコンポーネントにサインアップ機能を表示し、新規ユーザーがアプリケーションに登録してアクセスできるようにする必要があります。詳細なセットアップガイドについては、Hosted Authenticationのヘルプページを参照してください。 <br> vi. 確認画面で、**Yes, proceed**をクリックします。 <br> vii. 以下に一覧表示されているサポート対象のソーシャルログインオプションのいずれかを有効にし、選択したプロバイダーから対応する**ZAID**値を取得できます。 特定のソーシャルログインのZAIDの取得方法はこちら。 注意: Google、Microsoft、LinkedIn、FacebookなどのソーシャルログインプロバイダーはZAIDの取得に対応していますが、ZohoログインはこのZAID取得の目的には対応していません。 <br> このHosted Authenticationタイプの詳細はこちら。<br> 4. **セルフクライアントアプリケーションを登録する:** アプリケーションのユーザーに代わってCatalystリソースにアクセスするためのアプリケーションの認証・認可に、**Refresh Token**、**Client ID**、**Client Secret**を取得する必要があります。 上記の必要な項目を取得するには、まずAPIコンソールでアプリケーションをセルフクライアントとして登録する必要があります。 i. APIコンソールにログインし、**Self-client**をクリックします。 ii. アプリケーションがCatalystで実行する必要がある操作に基づいて、セルフクライアントアプリケーションのスコープを設定します。 利用可能なスコープの詳細はこちら。 iii. 必要なスコープを指定し、適切な説明を追加して、**Create**をクリックします。 iv. グラントトークンが生成されます。これは一度きりのプロセスであり、コンソールから再度取得できないため、必ずコピーして安全に保管してください。 グラントトークンの生成の詳細はこちら。 v. **Client Secret**タブに切り替えて、Client IDとClient Secretの詳細を控えておきます。 vi. このヘルプページのリクエストを使用して、アクセストークンとリフレッシュトークンを生成できます。また、このページに記載されている手順を使用して、アクセストークンを更新することもできます。 上記のすべての値を控えた後、以下に示すようにコードスニペットに設定し、Node.js SDKをアプリケーションに統合できます。以下のコードは、Catalyst CloudScale Stratusからバケットを取得する例で示しています。 <br> ### コードスニペット var catalyst = require("zcatalyst-sdk-node"); const express = require("express"); const app = express(); const port = 3006; const project_id = "PROJECT_ID"; //ここにプロジェクトIDを入力してください const project_key = "ZAID"; //ここにZAIDを入力してください const environment = "Development"; //"Development"または"Production"を指定してください const credentials = { refresh_token: "YOUR_REFRESH_TOKEN", //ここにリフレッシュトークンを入力してください client_id: "CLIENT_ID", //ここにクライアントIDを入力してください client_secret: "CLIENT_SECRET", //ここにクライアントシークレットを入力してください }; const CatalystCred = catalyst.credential.refreshToken(credentials); app.get("/listbuckets", async (req, res) => { try { req.project_id = project_id; req.project_key = project_key; req.environment = environment; req.credential = CatalystCred; let catalystApp = catalyst.initializeApp(req); const stratus = catalystApp.stratus(); const bucket_data = await stratus.listBuckets(); res.send(bucket_data); res.end(); } catch (err) { console.log(err.toString()); res.send(err); res.end(); } }); app.listen(port, async () => { console.log(`Server running on http://localhost:${port}`); }); #### Cloud Scale ##### Data Store -------------------------------------------------------------------------------- title: "Data Store インスタンスの取得" description: "このページでは、NodeJS アプリケーションの Data Store のテーブルから行を一括削除する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.325Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/data-store/get-component-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # Data Store ### コンポーネントインスタンスの取得 以下のメソッドで datastore の参照を作成できます。このメソッドはサーバー側の呼び出しを実行しません。 //Get a datastore instance let datastore = app.datastore(); -------------------------------------------------------------------------------- title: "テーブルメタデータの取得" description: "このページでは、NodeJS アプリケーションで単一テーブルまたは複数テーブルのメタデータを取得する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.325Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/data-store/get-table-meta/" service: "Cloud Scale" related: - Get table meta - API (/ja/api/code-reference/cloud-scale/data-store/get-table-metadata/#GetTableMetadata) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # テーブルメタデータの取得 Catalyst Data Store 内の単一テーブルのメタデータは、2 つの方法で取得できます。以下のコードスニペットで使用している datastore の参照は、コンポーネントインスタンスです。 ### テーブル ID によるテーブルメタデータの取得 以下のように、getTableDetails() メソッドを使用して、テーブル ID を参照してテーブルのメタデータを取得します。 //テーブルIDを使用して単一テーブルの詳細を取得する let datastore = app.datastore(); let tablePromise = datastore.getTableDetails(1510000000110121); tablePromise.then((table) => { console.log(table); }); 各バージョンで受信するサンプルレスポンスを以下に示します: { "project_id":{ "project_name":"AlienCity", "id":"2136000000007733" }, "table_name":"AlienCity", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 01:47 PM", "column_details":[ { "table_id":"2136000000007781", "column_sequence":"1", "column_name":"ROWID", "category":1, "data_type":"bigint", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":false, "column_id":"2136000000007784" }, { "table_id":"2136000000007781", "column_sequence":"2", "column_name":"CREATORID", "category":1, "data_type":"bigint", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":true, "column_id":"2136000000007786" }, { "table_id":"2136000000007781", "column_sequence":"3", "column_name":"CREATEDTIME", "category":1, "data_type":"datetime", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":true, "column_id":"2136000000007788" }, { "table_id":"2136000000007781", "column_sequence":"4", "column_name":"MODIFIEDTIME", "category":1, "data_type":"datetime", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":true, "column_id":"2136000000007790" }, { "table_id":"2136000000007781", "column_sequence":"5", "column_name":"CityName", "category":2, "data_type":"varchar", "max_length":"100", "is_mandatory":false, "decimal_digits":"2", "is_unique":true, "search_index_enabled":true, "column_id":"2136000000008503" } ], "table_id":"2136000000007781" } { "project_id":{ "project_name":"AlienCity", "id":2136000000007733 }, "table_name":"AlienCity", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "modified_time":"Aug 13, 2021 01:47 PM", "column_details":[ { "table_id":2136000000007781, "column_sequence":1, "column_name":"ROWID", "category":1, "data_type":"bigint", "max_length":50, "is_mandatory":false, "decimal_digits":2, "is_unique":false, "search_index_enabled":false, "column_id":2136000000007784 }, { "table_id":2136000000007781, "column_sequence":2, "column_name":"CREATORID", "category":1, "data_type":"bigint", "max_length":50, "is_mandatory":false, "decimal_digits":2, "is_unique":false, "search_index_enabled":true, "column_id":2136000000007786 }, { "table_id":2136000000007781, "column_sequence":3, "column_name":"CREATEDTIME", "category":1, "data_type":"datetime", "max_length":50, "is_mandatory":false, "decimal_digits":2, "is_unique":false, "search_index_enabled":true, "column_id":2136000000007788 }, { "table_id":2136000000007781, "column_sequence":4, "column_name":"MODIFIEDTIME", "category":1, "data_type":"datetime", "max_length":50, "is_mandatory":false, "decimal_digits":2, "is_unique":false, "search_index_enabled":true, "column_id":2136000000007790 }, { "table_id":2136000000007781, "column_sequence":5, "column_name":"CityName", "category":2, "data_type":"varchar", "max_length":100, "is_mandatory":false, "decimal_digits":2, "is_unique":true, "search_index_enabled":true, "column_id":2136000000008503 } ], "table_id":2136000000007781 } ### テーブル名によるテーブルメタデータの取得 テーブル名を参照してテーブルのメタデータを取得する場合は、以下のコードスニペットを使用できます。ただし、将来テーブル名が変更された場合、コード内で使用しているすべての箇所に反映する必要があることに注意してください。 いずれの場合も、Promise が返され、テーブルのメタデータの詳細に解決されます。結果のメタデータは、.toString() または .toJSON() メソッドにアクセスして、文字列または JSON 出力に変換できます。 //テーブル名を使用して単一テーブルの詳細を取得する let datastore = app.datastore(); let tablePromise = datastore.getTableDetails('SampleTable'); tablePromise.then((table) => { console.log(table); }); 各バージョンで受信するサンプルレスポンスを以下に示します: { "project_id":{ "project_name":"AlienCity", "id":"2136000000007733" }, "table_name":"AlienCity", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 01:47 PM", "column_details":[ { "table_id":"2136000000007781", "column_sequence":"1", "column_name":"ROWID", "category":1, "data_type":"bigint", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":false, "column_id":"2136000000007784" }, { "table_id":"2136000000007781", "column_sequence":"2", "column_name":"CREATORID", "category":1, "data_type":"bigint", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":true, "column_id":"2136000000007786" }, { "table_id":"2136000000007781", "column_sequence":"3", "column_name":"CREATEDTIME", "category":1, "data_type":"datetime", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":true, "column_id":"2136000000007788" }, { "table_id":"2136000000007781", "column_sequence":"4", "column_name":"MODIFIEDTIME", "category":1, "data_type":"datetime", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":true, "column_id":"2136000000007790" }, { "table_id":"2136000000007781", "column_sequence":"5", "column_name":"CityName", "category":2, "data_type":"varchar", "max_length":"100", "is_mandatory":false, "decimal_digits":"2", "is_unique":true, "search_index_enabled":true, "column_id":"2136000000008503" } ], "table_id":"2136000000007781" } { "project_id":{ "project_name":"AlienCity", "id":2136000000007733 }, "table_name":"AlienCity", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "modified_time":"Aug 13, 2021 01:47 PM", "column_details":[ { "table_id":2136000000007781, "column_sequence":1, "column_name":"ROWID", "category":1, "data_type":"bigint", "max_length":50, "is_mandatory":false, "decimal_digits":2, "is_unique":false, "search_index_enabled":false, "column_id":2136000000007784 }, { "table_id":2136000000007781, "column_sequence":2, "column_name":"CREATORID", "category":1, "data_type":"bigint", "max_length":50, "is_mandatory":false, "decimal_digits":2, "is_unique":false, "search_index_enabled":true, "column_id":2136000000007786 }, { "table_id":2136000000007781, "column_sequence":3, "column_name":"CREATEDTIME", "category":1, "data_type":"datetime", "max_length":50, "is_mandatory":false, "decimal_digits":2, "is_unique":false, "search_index_enabled":true, "column_id":2136000000007788 }, { "table_id":2136000000007781, "column_sequence":4, "column_name":"MODIFIEDTIME", "category":1, "data_type":"datetime", "max_length":50, "is_mandatory":false, "decimal_digits":2, "is_unique":false, "search_index_enabled":true, "column_id":2136000000007790 }, { "table_id":2136000000007781, "column_sequence":5, "column_name":"CityName", "category":2, "data_type":"varchar", "max_length":100, "is_mandatory":false, "decimal_digits":2, "is_unique":true, "search_index_enabled":true, "column_id":2136000000008503 } ], "table_id":2136000000007781 } ### すべてのテーブルのメタデータの取得 単一テーブルのメタデータの取得に加えて、getAllTables() メソッドを使用して、Catalyst プロジェクト内のすべてのテーブルの詳細を取得できます。 ここで返される Promise は、テーブルメタデータの詳細の配列に解決されます。 //すべてのテーブルのメタデータを取得する let datastore = app.datastore(); let allTablePromise = datastore.getAllTables(); allTablePromise.then((tables) => { console.log(tables); }); 各バージョンで受信するサンプルレスポンスを以下に示します: [ { "project_id":{ "project_name":"AlienCity", "id":"2136000000007733" }, "table_name":"AlienCity", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 01:47 PM", "table_id":"2136000000007781" }, "table_name":"CityDetails", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 01:47 PM", "table_id":"2136000000009090" } ] [ { "project_id":{ "project_name":"AlienCity", "id":2136000000007733 }, "table_name":"AlienCity", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "modified_time":"Aug 13, 2021 01:47 PM", "table_id":2136000000007781 }, "table_name":"CityDetails", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "modified_time":"Aug 13, 2021 01:47 PM", "table_id":2136000000009090 } ] -------------------------------------------------------------------------------- title: "テーブルインスタンスの取得" description: "このページでは、NodeJS アプリケーションの Data Store のテーブルから tableID と名前を使用してテーブルインスタンスを取得する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.326Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/data-store/get-table-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # テーブルインスタンスの取得 以下のメソッドでテーブルの参照を作成できます。これらのメソッドはサーバー側の呼び出しを実行しません。以下のコードスニペットで使用している datastore の参照は、コンポーネントインスタンスです。 ### テーブル ID を使用したテーブルインスタンスの取得 getTable() メソッドを使用して、テーブル ID を参照することでテーブルの参照を作成できます。 //Get a Single Table without details using table ID let datastore = app.datastore(); let table = datastore.table(1510000000110121); ### テーブル名を使用したテーブルインスタンスの取得 または、getTable() メソッドを使用して、テーブル名を参照することでテーブルの参照を作成できます。 これらのメソッドには Promise は含まれず、テーブルのインスタンスのみが返されます。 //Get a Single Table without details using table name let datastore = app.datastore(); let table = datastore.table('SampleTable'); -------------------------------------------------------------------------------- title: "カラムメタデータの取得" description: "このページでは、NodeJS アプリケーションの Data Store のテーブルから単一カラムまたは複数カラムのメタデータを取得する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.326Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/data-store/get-column-meta/" service: "Cloud Scale" related: - Get Column Meta - API (/ja/api/code-reference/cloud-scale/data-store/get-column-metadata/#GetColumnMetadata) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # カラムメタデータの取得 Catalyst Data Store のテーブルの単一カラムのメタデータの詳細は、以下のメソッドで取得できます。以下のコードスニペットで使用しているテーブルの参照は、テーブルインスタンスまたはテーブルメタのいずれかです。 ### ID によるカラムメタデータの取得 getColumnDetails() メソッドを使用して、特定のテーブルのカラムのメタデータを取得できます。 //Use Table Meta Object to get the column with column ID which returns a promise let datastore = app.datastore(); let table = datastore.table('ShipmentDetails'); let columnPromise = table.getColumnDetails(1510000000110832); columnPromise.then((column) => { console.log(column); }); 各バージョンで受信するサンプルレスポンスを以下に示します: { table_id: "2305000000007003", column_sequence: "5", column_name: "CityName", category: 2, data_type: "varchar", max_length: "100", is_mandatory: false, decimal_digits: "2", is_unique: true, search_index_enabled: false, column_id: "2305000000007725" } { table_id: 2305000000007003, column_sequence: 5, column_name: "CityName", category: 2, data_type: "varchar", max_length: 100, is_mandatory: false, decimal_digits: 2, is_unique: true, search_index_enabled: false, column_id: 2305000000007725 } ### 名前によるカラムメタデータの取得 カラムのメタデータを取得する別の方法として、カラム名を参照する方法があります。これは前述のものと同じレスポンスを返します。 カラムメタにはこれ以上の操作は含まれません。そのため、ここで返される Promise は JSON オブジェクトに解決されます。 //Use Table Meta Object to get the column with column ID which returns a promise let datastore = app.datastore(); let table = datastore.table('SampleTable'); let columnPromise = table.getColumnDetails('newColumn'); columnPromise.then((column) => { console.log(column); }); 各バージョンで受信するサンプルレスポンスを以下に示します: { table_id: "2305000000007003", column_sequence: "5", column_name: "CityName", category: 2, data_type: "varchar", max_length: "100", is_mandatory: false, decimal_digits: "2", is_unique: true, search_index_enabled: false, column_id: "2305000000007725" } { table_id: 2305000000007003, column_sequence: 5, column_name: "CityName", category: 2, data_type: "varchar", max_length: 100, is_mandatory: false, decimal_digits: 2, is_unique: true, search_index_enabled: false, column_id: 2305000000007725 } ### すべてのカラムのメタデータの取得 単一カラムのメタデータの取得に加えて、_getAllColumns()_ メソッドを使用して、特定のテーブルのすべてのカラムのメタデータを取得できます。 ここで返される Promise は、カラムメタデータの詳細の配列に解決されます。 //Use Table Meta Object to get all the columns which returns a promise let datastore = app.datastore(); let table = datastore.table('SampleTable'); let allColumnsPromise = table.getAllColumns(); allColumnsPromise.then((columns) => { console.log(columns); }); 各バージョンで受信するサンプルレスポンスを以下に示します: [ { table_id: "2136000000007781", column_sequence: "1", column_name: "ROWID", category: 1, data_type: "bigint", max_length: "50", is_mandatory: false, decimal_digits: "2", is_unique: false, search_index_enabled: false, column_id: "2136000000007784" }, { table_id: "2136000000007781", column_sequence: "2", column_name: "CREATORID", category: 1, data_type: "bigint", max_length: "50", is_mandatory: false, decimal_digits: "2", is_unique: false, search_index_enabled: true, column_id: "2136000000007786" }, { table_id: "2136000000007781", column_sequence: "3", column_name: "CREATEDTIME", category: 1, data_type: "datetime", max_length: "50", is_mandatory: false, decimal_digits: "2", is_unique: false, search_index_enabled: true, column_id: "2136000000007788" }, { table_id: "2136000000007781", column_sequence: "4", column_name: "MODIFIEDTIME", category: 1, data_type: "datetime", max_length: "50", is_mandatory: false, decimal_digits: "2", is_unique: false, search_index_enabled: true, column_id: "2136000000007790" }, { table_id: "2136000000007781", column_sequence: "5", column_name: "CityName", category: 2, data_type: "varchar", max_length: "100", is_mandatory: false, decimal_digits: "2", is_unique: true, search_index_enabled: true, column_id: "2136000000008503" } ] [ { table_id: 2136000000007781, column_sequence: 1, column_name: "ROWID", category: 1, data_type: "bigint", max_length: 50, is_mandatory: false, decimal_digits: 2, is_unique: false, search_index_enabled: false, column_id: 2136000000007784 }, { table_id: 2136000000007781, column_sequence: 2, column_name: "CREATORID", category: 1, data_type: "bigint", max_length: 50, is_mandatory: false, decimal_digits: 2, is_unique: false, search_index_enabled: true, column_id: 2136000000007786 }, { table_id: 2136000000007781, column_sequence: 3, column_name: "CREATEDTIME", category: 1, data_type: "datetime", max_length: 50, is_mandatory: false, decimal_digits: 2, is_unique: false, search_index_enabled: true, column_id: 2136000000007788 }, { table_id: 2136000000007781, column_sequence: 4, column_name: "MODIFIEDTIME", category: 1, data_type: "datetime", max_length: 50, is_mandatory: false, decimal_digits: 2, is_unique: false, search_index_enabled: true, column_id: 2136000000007790 }, { table_id: 2136000000007781, column_sequence: 5, column_name: "CityName", category: 2, data_type: "varchar", max_length: 100, is_mandatory: false, decimal_digits: 2, is_unique: true, search_index_enabled: true, column_id: 2136000000008503 } ] -------------------------------------------------------------------------------- title: "行の取得" description: "このページでは、NodeJS アプリケーションの Data Store のテーブルから単一行またはすべての行を取得する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.326Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/data-store/get-rows/" service: "Cloud Scale" related: - Get rows - API (/ja/api/code-reference/cloud-scale/data-store/get-all-rows/#GetAllRows) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の取得 Catalyst Data Store のテーブルから、単一行または複数行のデータを取得できます。これらのコードスニペットで使用している table の参照は、テーブルインスタンスまたはテーブルメタのいずれかです。 ### 単一行の取得 getRow() メソッドを使用して、テーブルから単一行を取得できます。以下のサンプルコードに示すように、このメソッドに行の一意の Row ID を渡す必要があります。 ここで返される Promise は JSON の行オブジェクトに解決されます。 //テーブルインスタンスまたはテーブルメタオブジェクトを使用して行IDを渡して行を取得する let rowPromise = table.getRow(1510000000109476); 受信するサンプルレスポンスを以下に示します。レスポンスは Node.js の両方のバージョンで同じです。 { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-17 13:02:11:184", CREATEDTIME: "2021-08-16 16:29:10:499", CityName: "Pune", ROWID: "2136000000011011" } ### ページネーションによる全行の取得 getMyPagedRows() 関数を使用してコードにページネーションを組み込むことで、Data Store のテーブルからすべてのデータ行を取得できます。ページネーションを使用すると、イテレーションを通じてテーブルの行をバッチまたはページ単位で取得できます。 このイテレーションは、以下のコードに示すように hasNext, で検証されるすべての行が取得されるまで実行されます。テーブルは一意のテーブル ID で参照できます。 たとえば、各ページで 100 行ずつのバッチで行を取得する場合、各ページで取得する最大行数の変数を定義し、数を指定できます。以下のサンプルコードでは、maxRows を 100 に設定しています。 Note: maxRows パラメータはオプションです。この値を指定しない場合、SDK の呼び出しはデフォルトで 1 ページあたり 200 行を返します。 さらに、ループの各実行後に、後続のデータ取得を認可するトークン文字列がレスポンスデータに含まれます。このトークンは next\_token を通じて取得でき、以下のコードに示すように、後続のイテレーション時に nextToken の値として渡します。ループの最初の実行時、nextToken 文字列の値は undefined に設定されます。次のレコードセットは、レスポンスデータの more\_records を通じて取得されます。 Note: ページネーションは Node.js SDK v2.1.0 アップデートから利用可能になりました。古いバージョンの Node.js SDK では利用できません。 //ページネーションで行を取得し、最初のイテレーションではnextTokenの値をundefinedとして宣言する function getMyPagedRows(hasNext = true, nextToken = undefined) { if (!hasNext) { return; } dataStore.table(195000000042025) //レコードを取得するテーブルのテーブルIDを指定する .getPagedRows({ nextToken, maxRows: 100 }) //1ページで取得する最大行数を定義する and pass it along with nextToken .then(({ data, next_token, more_records }) => { console.log('rows : ', data); //テーブルから行を取得する return getMyPagedRows(more_records, next_token); //次のレコードセットと次の反復用のトークン文字列を取得する }) .catch((err) => { console.log(err.toString()); }); } さらにレコードがある場合に受信するサンプルレスポンスを以下に示します。この場合、more_records パラメータは true に設定されます。 #### Node.js v2.1.0 { "status": 200, "data": [ { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:24:855", "name": "Alex Jones", "CREATEDTIME": "2022-01-11 18:18:24:855", "ROWID": "3359000000108111" }, { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:25:117", "name": "Robert Neal", "CREATEDTIME": "2022-01-11 18:18:25:117", "ROWID": "3359000000108114" }, { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:25:120", "name": "Roslyn Gunn", "CREATEDTIME": "2022-01-11 18:18:25:120", "ROWID": "3359000000108117" } ], "message": "OK", "more_records": true, "next_token": "{{token}}" } これ以上レコードがない場合に受信するサンプルレスポンスを以下に示します。この場合、more_records パラメータは false に設定されます。 #### Node.js v2.1.0 { "status": 200, "data": [ { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:43:556", "name": "Alex Jones", "CREATEDTIME": "2022-01-11 18:18:43:556", "ROWID": "3359000000108410" }, { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:43:557", "name": "Robert Neal", "CREATEDTIME": "2022-01-11 18:18:43:557", "ROWID": "3359000000108413" }, { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:43:568", "name": "Roslyn Gunn", "CREATEDTIME": "2022-01-11 18:18:43:568", "ROWID": "3359000000108417" } ], "message": "OK", "more_records": false } Note: 以前テーブルから複数行のデータを取得するために提供されていた getAllRows() メソッドのサポートは廃止されました。ページネーションは、取得する行数に制限なくすべての行を取得できる拡張機能として利用可能になりました。getAllRows() メソッドは、今後のすべての SDK バージョンから削除される予定です。コードを適宜アップグレードしてください。 -------------------------------------------------------------------------------- title: "行の挿入" description: "このページでは、NodeJS アプリケーションの Data Store のテーブルに単一行または一括で行を挿入する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.326Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/data-store/insert-rows/" service: "Cloud Scale" related: - Insert Rows - API (/ja/api/code-reference/cloud-scale/data-store/insert-new-row/#InsertNewRow) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の挿入 テーブルの一意の ID または名前を参照して、Data Store のテーブルに新しいデータ行またはレコードを挿入できます。次のセクションで説明するように、テーブルに複数行を挿入することもできます。 以下のコードで使用している table の参照は、以前作成したテーブルインスタンスまたはテーブルメタのいずれかです。 Note: * テーブルとそのカラムは事前に作成されている必要があります。コンソールからテーブルの作成とカラムの作成が可能です。 * 開発環境では、各プロジェクトの各テーブルに最大 5,000 件のレコードを挿入できます。開発環境では、各プロジェクト全体で最大 25,000 件のレコードを作成できます。本番環境ではレコード作成に上限はありません。 ### 単一行の挿入 _{カラム名 : カラム値}_ 形式で行の詳細を含む JSON オブジェクトを作成し、以下に示すように insertRow() メソッドの引数として渡す必要があります。これにより、名前または一意のテーブル ID で参照したテーブルに行が挿入されます。行が挿入されると、行の一意の RowID 値が自動的に生成されます。 ここで返される Promise は JSON の行オブジェクトに解決されます。 //Create a JSON object with the rows to be inserted let rowData = { Name: `George Hamilton`, Age: 22, ID: 6868 }; //テーブルメタオブジェクトを使用してPromiseを返す行を挿入する let datastore = app.datastore(); let table = datastore.table('EmpDetails'); let insertPromise = table.insertRow(rowData); insertPromise.then((row) => { console.log(row); }); 各バージョンで受信するサンプルレスポンスを以下に示します: { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-16 16:29:10:499", Name: "George Hamilton", Age: "22", ID: "6868", CREATEDTIME: "2021-08-16 16:29:10:499", ROWID: 2136000000011011 } ### 複数行の挿入 行を含む配列を構築し、以下に示すように insertRows() メソッドの引数として渡すことで、テーブルに複数行を挿入できます。ここで返される Promise は、行オブジェクトを含む配列に解決されます。 //Create a JSON array with the rows to be inserted let rowData = [{ Name: `Mark Wellington`, Age: 29, ID: 7218 }, { Name: `Zendaya Jones`, Age: 32, ID: 3211 } ]; //テーブルメタオブジェクトを使用してPromiseを返す複数行を挿入する promise let datastore = app.datastore(); let table = datastore.table('EmpDetails'); let insertPromise = table.insertRows(rowData); insertPromise.then((rows) => { console.log(rows); }); 受信するサンプルレスポンスを以下に示します。レスポンスは両方のバージョンで同じです。 [ { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-25 13:55:04:904", Name: "Mark Wellington", Age: "92", ID: "7218", CREATEDTIME: "2021-08-25 13:55:04:904", ROWID: 2136000000038008 }, { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-25 13:55:04:906", Name: "Zendaya Jones", Age: "32", ID: "3211", CREATEDTIME: "2021-08-25 13:55:04:906", ROWID: 2136000000038010 } ] -------------------------------------------------------------------------------- title: "行の更新" description: "このページでは、NodeJS アプリケーションの Data Store のテーブルで単一行または一括で行を更新する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.326Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/data-store/update-rows/" service: "Cloud Scale" related: - Update Rows - API (/ja/api/code-reference/cloud-scale/data-store/update-row/#UpdateRow) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の更新 Catalyst Data Store のテーブルで、単一行または複数行を更新し、1 つ以上のカラム値を更新できます。以下のコードスニペットで使用している table の参照は、テーブルインスタンスまたはテーブルメタのいずれかです。 ### 単一行の更新 このメソッドでは、必要なカラムに変更された値を持つオブジェクトを構築して単一行を更新できます。一意の ROWID を参照し、新しく構築したオブジェクトを updateRow() メソッドに渡します。ここで ROWID は必須の属性です。ここで返される Promise は JSON の行オブジェクトに解決されます。 //Construct a JSON Object with the updated row details let updatedRowData = { Name: `Mathew Jones`, Age: 31, ROWID: 1510000000109474 }; //テーブルメタオブジェクトを使用してROWIDで単一行を更新し、Promiseを返す let datastore = app.datastore(); let table = datastore.table('SampleTable'); let rowPromise = table.updateRow(updatedRowData); rowPromise.then((row) => { console.log(row); }); 受信するサンプルレスポンスを以下に示します。レスポンスは Node.js の両方のバージョンで同じです。 #### Node.js { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-17 13:02:11:184", CREATEDTIME: "2021-08-16 16:29:10:499", Name: "Mathew Jones", Age: 31, ROWID: "2136000000011011" } ### 複数行の更新 複数行を更新するには、変更された値を含むオブジェクトの配列を構築し、updateRows() メソッドの引数として渡します。対応する配列オブジェクト内の ROWIDs を使用して、変更が必要な特定の行を参照します。 ここで返される Promise は、行オブジェクトの配列に解決されます。 //Data to be updated along with the ROWID let updatedRowsData = [{ Name: `Mathew Jones`, Age: 31, ROWID: 1510000000113298 }, { Name: `Rhonda Watson`, Age: 28, ROWID: 1510000000109474 }]; //テーブルメタオブジェクトを使用してROWIDsで複数行を更新し、Promiseを返す let datastore = app.datastore(); let table = datastore.table('SampleTable'); let rowPromise = table.updateRows(updatedRowsData); rowPromise.then((rows) => { console.log(rows); }); 受信するサンプルレスポンスを以下に示します。レスポンスは Node.js の両方のバージョンで同じです。 #### Node.js [ { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-24 13:22:14:718", CREATEDTIME: "2021-08-24 13:12:55:999", Name: "Mathew Jones", Age: 31, ROWID: "2136000000034043" }, { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-24 13:22:14:728", CREATEDTIME: "2021-08-24 13:12:56:001", Name: "Rhonda Watson", Age: 28, ROWID: "2136000000034045" } ] -------------------------------------------------------------------------------- title: "行の削除" description: "このページでは、NodeJS アプリケーションの Data Store のテーブルから単一行を削除する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.326Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/data-store/delete-row/" service: "Cloud Scale" related: - Delete row - API (/ja/api/code-reference/cloud-scale/data-store/delete-row/#DeleteRow) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の削除 ROWID を deteleRow() メソッドのパラメータとして渡すだけで、テーブルから行を削除できます。一度に複数行を削除することはできません。 ここで返される Promise は JSON である行オブジェクトに解決されます。 //Use Table Meta Object to delete a single row using ROWID which returns a promise let datastore = app.datastore(); let table = datastore.table('SampleTable'); let rowPromise = table.deleteRow(1510000000109476); rowPromise.then((row) => { console.log(row); }); -------------------------------------------------------------------------------- title: "行の一括読み取り" description: "このページでは、NodeJS アプリケーションの Data Store のテーブルから複数行を読み取る方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.327Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/data-store/bulk-read/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の一括読み取り Catalyst では、Data Store 内の特定のテーブルに対して一括読み取りジョブを実行できます。 以下の SDK スニペットでは、一括読み取りジョブが特定のテーブルから数千のレコードを読み取り、ジョブが成功した場合に読み取り操作の結果を含む CSV ファイルを生成します。テーブルは一意のTable IDで参照されます。 Note: dataStore.table().bulkJob('read' | 'write') メソッドを使用して、一括読み取りまたは一括書き込みジョブのいずれかを実行することもできます。 <table class="content-table"> <thead> <tr> <th>使用メソッド</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>bulkRead.createJob({ criteria, page, select_columns })</td> <td>新しい一括読み取りジョブを作成します。</td> </tr> <td>bulkRead.getStatus(job ID)</td> <td>一括読み取りジョブのステータスを取得します。</td> <tr> <td>bulkRead.getResult(job ID)</td> <td>一括読み取りジョブの結果を取得します。</td> </tr> </tbody> </table> 以下の SDK スニペットをコピーして、特定のテーブルに対して一括読み取りジョブを実行します。 // 一括読み取り let datastore = app.datastore(); //データストアインスタンスを取得する const bulkRead = dataStore.table('sampleTable').bulkJob('read'); // 一括読み取りジョブを作成する const bulkReadJob = await bulkRead.createJob({ criteria: { group_operator: 'or', group: [ { column_name: 'Department', comparator: 'equal', value: 'Marketing' }, { column_name: 'EmpID', comparator: 'greater_than', value: '1000' }, { column_name: 'EmpName', comparator: 'starts_with', value: 'S' } ] }, page: 1, select_columns: ['EmpID', 'EmpName', 'Department'] }; { url: 'https://hr.zylker.com/ja/EmpRecords/_callback.php', headers: { 'src': 'ZCatalyst', 'operation': 'bulkreadAPI' }, params: { 'project_name': 'EmployeeDatabase' } }); // 一括読み取りステータスを取得する await bulkRead.getStatus(bulkReadJob.job_id); // 一括読み取り結果を取得する await bulkRead.getResult(bulkReadJob.job_id); <br /> Note: 最大 200,000 行を同時に読み取ることができます。 -------------------------------------------------------------------------------- title: "行の一括書き込み" description: "このページでは、NodeJS アプリケーションの Data Store のテーブルに複数行を書き込む方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.327Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/data-store/bulk-write/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の一括書き込み Catalyst では、Data Store 内の特定のテーブルに対して一括書き込みジョブを実行できます。一括書き込み操作は、Stratus にアップロードされた CSV ファイルから数千のレコードを取得し、特定のテーブルに挿入します。 テーブルは、作成時に Catalyst によって生成される一意のtable IDで参照されます。書き込み操作を実行するカラムは、一意のcolumn IDで参照されます。 Note: 一括書き込み操作を実行するには、まず必要なデータを CSV ファイルとして Stratus にアップロードする必要があります。 書き込みジョブ中、ファイルは以下の属性を使用して参照されます: * bucketName: オブジェクトが格納されているバケットの名前です。 * objectKey: 必要なオブジェクトのパスまたはオブジェクト URLを含めることができます。 * versionID: バケットでバージョニングが有効になっている場合、ファイルの特定の versionID がこの属性に格納されます。 <table class="content-table"> <thead> <tr> <th>使用メソッド</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>bulkWrite.createJob(objectDetails, {find_by,fk_mapping,operation})</td> <td>特定のテーブルに新しい一括書き込みジョブを作成します。</td> </tr> <td>bulkWrite.status(job ID)</td> <td>一括書き込み操作のステータスを取得します。</td> <tr> <td>bulkWrite.result(job ID)</td> <td>一括書き込み操作の結果を取得します。</td> </tr> </tbody> </table> 以下の SDK スニペットをコピーして、特定のテーブルに対して一括書き込みジョブを実行します。 let datastore = app.datastore(); // datastoreインスタンスを取得 const bulkWrite = datastore.table('sampleTable').bulkJob('write'); const objectDetails = { "bucket_name": "zylker14266", "object_key": "emp_records.csv", "version_id": "64832huidksnd83" }; // 一括書き込みジョブを作成する const bulkWriteJob = await bulkWrite.createJob(objectDetails, { find_by: 'EmpID', fk_mapping: [ { local_column: 'EmployeeID', reference_column: 'EmpID' }, { local_column: 'DepartmentID', reference_column: 'DeptID' } ], operation: 'insert' }); // 一括書き込みステータスを取得する await bulkWrite.getStatus(bulkWriteJob.job_id); // 一括書き込み結果を取得する await bulkWrite.getResult(bulkWriteJob.job_id); <br /> Note: 一度に最大 100,000 行を書き込むことができます。 -------------------------------------------------------------------------------- title: "行の一括削除" description: "このページでは、NodeJS アプリケーションの Data Store のテーブルから行を一括削除する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.327Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/data-store/bulk-delete-rows/" service: "Cloud Scale" related: - Bulk delete rows - API (/ja/api/code-reference/cloud-scale/data-store/bulk-delete-rows/#BulkDeleteRows) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の一括削除 Catalyst では、Data Store 内の特定のテーブルから、レコードまたはデータ行を一括削除できます。テーブルは一意の ID または名前で参照します。テーブル ID は Data Store から、またはコンソールでテーブルを開いたときの URL から取得できます。 一括削除操作では、1 回の操作で最大 200 行を削除できます。以下のサンプルコードに示すように、削除する行の一意の ROWID を配列に渡すことができます。コードには少なくとも 1 つの ROWID を含める必要があり、最大 200 の ROWID を含めることができます。 行は、サンプルコードの rowPromise を通じて deleteRows() 関数に渡されます。テーブル名またはテーブル ID は datastore.table() に渡す必要があります。 以下で使用している datastore の参照は、コンポーネントインスタンスページで定義されています。 let datastore = app.datastore(); //テーブルIDまたはテーブル名を渡す let table = datastore.table('EmpDetails'); //削除するレコードのROWIDをdeleteRows()関数に渡す let rowPromise = table.deleteRows([1028000000171815,1028000000171810, 1028000000171805, 1028000000171617, 1028000000171098]); //Promiseを返しCatalystにプッシュする rowPromise.then((row) => { console.log(row); }); ##### File Store -------------------------------------------------------------------------------- title: "File Store インスタンスの取得" description: "このページでは、NodeJSアプリケーションでFile Storeからフォルダを削除するメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.328Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/file-store/get-component-instance/" service: "Cloud Scale" related: - Get Component Instance - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder) - File Store (/ja/cloud-scale/help/file-store/introduction/) -------------------------------------------------------------------------------- # File Store Note: Catalystでは、Early AccessモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />Early AccessモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 ### コンポーネントインスタンスの取得 File Storeの参照は、以下のメソッドで作成できます。このメソッドはサーバーサイドの呼び出しを発生させません。 //Get a file store instance let filestore = app.filestore(); -------------------------------------------------------------------------------- title: "フォルダインスタンスの取得" description: "このページでは、NodeJSアプリケーションでFile Storeからフォルダインスタンスを取得するメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.328Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/file-store/get-folder-instance/" service: "Cloud Scale" related: - Get Folder Instance - API (/ja/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder) - File Store (/ja/cloud-scale/help/file-store/introduction) -------------------------------------------------------------------------------- # フォルダインスタンスの取得 Note: Catalystでは、Early AccessモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />Early AccessモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 フォルダの参照は、以下のメソッドで作成できます。このメソッドはサーバーサイドの呼び出しを発生させません。以下のコードスニペットで使用されているfilestoreの参照は、コンポーネントインスタンスです。 上記のメソッドにはPromiseは関与せず、フォルダのインスタンスのみが返されます。 // Folderインスタンスを取得 let filestore = app.filestore(); let folder = filestore.folder(1510000000109545); -------------------------------------------------------------------------------- title: "フォルダ詳細の取得" description: "このページでは、NodeJSアプリケーションでFile Storeからフォルダの詳細を取得するメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.328Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/file-store/retrieve-folder-details/" service: "Cloud Scale" related: - Retrieve Folder Details - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder) - File Store (/ja/cloud-scale/help/file-store/introduction/) -------------------------------------------------------------------------------- # フォルダの詳細の取得 Note: Catalystでは、Early AccessモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />Early AccessモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 Catalyst File Storeに作成されたフォルダの詳細を取得できます。単一のフォルダまたはFile Store内のすべてのフォルダの詳細を取得できます。以下のコードスニペットで使用されているfilestoreの参照は、先に作成したコンポーネントインスタンスです。 ### 単一フォルダの詳細の取得 このメソッドは、一意のFolder IDで参照される特定のフォルダの詳細を、getFolderDetails()メソッドを呼び出して取得します。 ここではPromiseが返され、フォルダのメタ詳細に解決されます。結果のメタは、.toString()または.toJSON()メソッドにアクセスすることで、文字列またはJSON出力に変換できます。 //Get a single folder with details by passing the folder id which in turn returns a promise let filestore = app.filestore(); let folderPromise = filestore.getFolderDetails(1510000000109545); folderPromise.then((folder) => { console.log(folder); }); 各バージョンで受け取るサンプルレスポンスを以下に示します: { "folder_name":"Store_Data", "created_time":"Aug 13, 2021 05:32 PM", "created_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 05:32 PM", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "project_details":{ "project_name":"ShipmentTracking", "id":"2136000000007733", "project_type":"Live" }, "file_details":[ { "id":"2136000000020111", "file_location":null, "file_name":"Img.jpeg", "file_size":"84881", "created_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"p.boyle@zylker.com", "first_name":"Patricia", "last_name":"Boyle", "user_type":"Admin", "user_id":"2136000000006767" }, "created_time":"Aug 17, 2021 09:32 PM", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"p.boyle@zylker.com", "first_name":"Patricia", "last_name":"Boyle", "user_type":"Admin", "user_id":"2136000000006767" }, "modified_time":"Aug 17, 2021 09:32 PM", "project_details":{ "project_name":"ShipmentTracking", "id":"2136000000007733", "project_type":"Live" }, "folder_details":"2136000000008551" } ], "id":"2136000000008551" } } { "folder_name":"Store_Data", "created_time":"Aug 13, 2021 05:32 PM", "created_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "modified_time":"Aug 13, 2021 05:32 PM", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "project_details":{ "project_name":"ShipmentTracking", "id":2136000000007733, "project_type":"Live" }, "file_details":[ { "id":2136000000020111, "file_location":null, "file_name":"invoice1349.jpeg", "file_size":84881, "created_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"p.boyle@zylker.com", "first_name":"Patricia", "last_name":"Boyle", "user_type":"Admin", "user_id":2136000000006767 }, "created_time":"Aug 17, 2021 09:32 PM", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"p.boyle@zylker.com", "first_name":"Patricia", "last_name":"Boyle", "user_type":"Admin", "user_id":2136000000006767 }, "modified_time":"Aug 17, 2021 09:32 PM", "project_details":{ "project_name":"ShipmentTracking", "id":2136000000007733, "project_type":"Live" }, "folder_details":2136000000008551 } ], "id":2136000000008551 } ### すべてのフォルダの詳細の取得 getAllFolders()メソッドを使用して、Catalystアプリケーション内のすべてのフォルダの詳細を取得できます。 ここで返されるPromiseは、フォルダメタ詳細の配列に解決されます。 //Get details of all the folders in the project let filestore = app.filestore(); let allFolderPromise = filestore.getAllFolders(); allFolderPromise.then((folders) => { console.log(folders); }); 各バージョンで受け取るサンプルレスポンスを以下に示します: [ { "folder_name":"Invoices", "created_time":"Aug 25, 2021 11:38 AM", "created_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 25, 2021 11:38 AM", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "project_details":{ "project_name":"ShipmentTracking", "id":"2136000000007733", "project_type":"Live" }, "id":"2136000000037021" }, { "folder_name":"Store_Data", "created_time":"Aug 13, 2021 05:32 PM", "created_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 05:32 PM", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "project_details":{ "project_name":"ShipmentTracking", "id":"2136000000007733", "project_type":"Live" }, "id":"2136000000008551" } ] [ { "folder_name":"Invoices", "created_time":"Aug 25, 2021 11:38 AM", "created_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "modified_time":"Aug 25, 2021 11:38 AM", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "project_details":{ "project_name":"ShipmentTracking", "id":2136000000007733, "project_type":"Live" }, "id":2136000000037021 }, { "folder_name":"Store_Data", "created_time":"Aug 13, 2021 05:32 PM", "created_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "modified_time":"Aug 13, 2021 05:32 PM", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "project_details":{ "project_name":"ShipmentTracking", "id":2136000000007733, "project_type":"Live" }, "id":2136000000008551 } ] -------------------------------------------------------------------------------- title: "ファイルのアップロード" description: "このページでは、NodeJSアプリケーションでFile Storeのフォルダにファイルをアップロードするメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.328Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/file-store/upload-file/" service: "Cloud Scale" related: - Upload File - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-file/#GetSpecificFile) - File Store (/ja/cloud-scale/help/file-store/introduction/) -------------------------------------------------------------------------------- # ファイルのアップロード Note: Catalystでは、Early AccessモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />Early AccessモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 フォルダの一意のIDを参照して、ローカルシステムからFile Store内の既存のフォルダにファイルをアップロードできます。画像、テキストドキュメント、CSV、またはその他の種類のファイルをアップロードできます。アップロードできるファイルの最大サイズは100 MBです。ファイルがアップロードされると、一意のFile IDが作成されます。 Catalystは、開発環境の各プロジェクトに1 GBのFile Storeスペースを提供します。本番環境ではストレージの上限はありません。 #### JSON設定の作成 最初に、以下に示すように、アップロードするファイルのJSON設定オブジェクトを作成する必要があります。このJSONオブジェクトはファイルのReadStream()を作成します。オプションでファイル名を含めることができます。 //Create a JSON object with the file and its name, using the keys 'name' and 'code' let config = { code:fs.createReadStream('empdata.csv'), name: 'testFile.txt' }; ### ファイルのアップロード 次に、以下に示すように、JSONオブジェクトをuploadFile()メソッドに渡してファイルをアップロードする必要があります。 先に作成したフォルダ参照またはフォルダメタを使用して、ファイルをアップロードするフォルダを参照できます。フォルダの一意のFolder IDを渡す必要があります。ここで返されるPromiseは、アップロードされたファイル情報を含むJSONオブジェクトに解決されます。 //Upload the file by passing the JSON config to the method, which in turn returns a promise let filestore = app.filestore(); let folder = filestore.folder(1510000000109545); //フォルダIDを指定する let uploadPromise = folder.uploadFile(config); //ファイル用に作成されたJSONオブジェクトを渡す uploadPromise.then((fileObject) => { console.log(fileObject); }); 各バージョンで受け取るサンプルレスポンスを以下に示します: { id: "2136000000020122", file_location: null, file_name: "empdata.csv", file_size: "84881", created_by: { zuid: "66466723", is_confirmed: false, email_id: "emma@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: "2136000000006003" }, created_time: "Aug 17, 2021 09:33 PM", modified_by: { zuid: "66466723", is_confirmed: false, email_id: "emma@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: "2136000000006003" }, modified_time: "Aug 17, 2021 09:33 PM", project_details: { project_name: "ShipmentTracking", id: "2136000000007733" }, folder_details: "2136000000008551" } { id: 2136000000020117, file_location: null, file_name: "empdata.csv", file_size: 84881, created_by: { zuid: 66466723, is_confirmed: false, email_id: "emma@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: 2136000000006003 }, created_time: "Aug 17, 2021 09:33 PM", modified_by: { zuid: 66466723, is_confirmed: false, email_id: "emma@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: 2136000000006003 }, modified_time: "Aug 17, 2021 09:33 PM", project_details: { project_name: "ShipmentTracking", id: 2136000000007733 }, folder_details: 2136000000008551 } -------------------------------------------------------------------------------- title: "フォルダからファイルのダウンロード" description: "このページでは、NodeJSアプリケーションでFile Storeのフォルダからファイルをダウンロードするメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.329Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/file-store/download-file-from-folder/" service: "Cloud Scale" related: - Download File from Folder - API (/ja/api/code-reference/cloud-scale/file-store/delete-file/#description) - File Store (/ja/cloud-scale/help/file-store/introduction/) -------------------------------------------------------------------------------- # フォルダからのファイルのダウンロード Note: Catalystでは、Early AccessモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />Early AccessモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 一意のFileIDを参照して、フォルダからファイルをダウンロードできます。以下のコードスニペットでは、フォルダ参照またはフォルダメタが使用されています。FileIDはdownloadFile()メソッドの引数として渡されます。 ここで返されるPromiseは、ファイルのコンテンツを含むバッファに解決されます。 //Download the file by passing the file ID to the method which in turn returns a promise let filestore = app.filestore(); let folder = filestore.folder(1510000000109545); let downloadPromise = folder.downloadFile(1510000000107568); downloadPromise.then((fileObject) => { console.log(fileObject); }); -------------------------------------------------------------------------------- title: "ファイルの削除" description: "このページでは、Javaアプリケーションでのfile Storeからフォルダを削除するメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.329Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/file-store/delete-file/" service: "Cloud Scale" related: - Delete a File - API (/ja/api/code-reference/cloud-scale/file-store/delete-file/#DeleteFile) - File Store (/ja/cloud-scale/help/file-store/introduction/) -------------------------------------------------------------------------------- # ファイルの削除 Note: Catalystでは、Early AccessモードでStratusと呼ばれる新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />Early AccessモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 File IDを参照して、フォルダ内のファイルを削除できます。以下のコードスニペットでは、フォルダ参照またはフォルダメタが使用されています。fileIDはdeleteFile()メソッドのパラメータとして渡されます。 ここで返されるPromiseは、削除されたファイルオブジェクト（JSON）に解決されます。 // ファイルIDをメソッドに渡してファイルを削除（Promiseを返します） let filestore = app.filestore(); let folder = filestore.folder(1510000000109545); let deletePromise = folder.deleteFile(1510000000107568); deletePromise.then((fileObject) => { console.log(fileObject); }); ##### NoSQL -------------------------------------------------------------------------------- title: "コンポーネントインスタンスの取得" description: "Catalyst NoSQLは、非リレーショナルでNoSQLのデータストレージを提供する、完全マネージドで強力なデータベースです。このページでは、新しいNoSQLコンポーネントインスタンスを作成するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.329Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/nosql/get-component-instance/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/insert-item/#InsertNewItem) - NoSQL Java SDK (/ja/sdk/java/v1/cloud-scale/nosql/get-table-metadata/) - NoSQL Python SDK (/ja/sdk/python/v1/cloud-scale/nosql/get-component-instance/) -------------------------------------------------------------------------------- # NoSQL Catalyst NoSQLは、アプリケーションの半構造化データ、非構造化データ、および異種データを保存できる、完全マネージドの非リレーショナルNoSQLデータストレージ機能です。Catalystは、キーバリューペアベースのJSON形式でのドキュメント型データストレージをサポートしています。 Catalyst NoSQL Node.js SDKパッケージを使用すると、プロジェクト内のNoSQLテーブルに対してCRUDデータ操作を実行できます。NoSQLテーブルのメタデータを取得し、さまざまなサポートされているデータ型のNoSQLアイテムを作成し、特定のテーブルにアイテムを挿入、更新、取得、または削除できます。また、クエリ条件を指定してテーブルやテーブルのインデックスをクエリすることもできます。 ### NoSQLインスタンスの作成 コンポーネントインスタンスは、特定のコンポーネントに固有の事前定義された設定にアクセスするために使用できるオブジェクトです。 以下に示すように、Node.jsでSDK操作を実行するためのNoSQLオブジェクトを作成できます。これはサーバーサイドの呼び出しを発生させません。このnosqlインスタンスは、NoSQLを操作するさまざまなコードスニペットで参照します。 NoSQLインスタンスの作成に使用されるappの参照は、SDKの初期化時にレスポンスとして返されるNode.jsオブジェクトです。 // NoSQLインスタンスを作成 const nosql = app.nosql(); -------------------------------------------------------------------------------- title: "テーブルメタデータの取得" description: "Catalyst NoSQLは、非リレーショナルでNoSQLのデータストレージを提供する、完全マネージドで強力なデータベースです。このページでは、NoSQLテーブルのメタデータを取得するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.329Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/nosql/get-table-metadata/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Create and Manage Tables (/ja/cloud-scale/help/nosql/create-manage-tables/) -------------------------------------------------------------------------------- # NoSQLテーブルメタデータの取得 以下に説明するように、プロジェクト内の単一のCatalyst NoSQLテーブルまたはすべてのテーブルのメタデータを取得できます。 ### 単一テーブルのメタデータの取得 Catalyst NoSQL内の単一テーブルのメタデータは、このページで説明する2つの方法で取得できます。レスポンスには、パーティションキーとソートキー、TTL属性などのテーブル設定の詳細が含まれます。 以下のコードスニペットで使用されているnosqlの参照は、これらの操作を実行するために作成されたコンポーネントインスタンスです。 #### テーブルIDによるテーブルメタデータの取得 以下に示すように、getTable()メソッドを使用して、一意のテーブルIDでプロジェクト内のNoSQLテーブルのメタデータを取得できます。 // NoSQLインスタンスを作成 const nosql = app.nosql(); // テーブルIDを使用してテーブルメタデータを取得する const tableA = await nosql.getTable('124567890'); #### テーブル名によるテーブルメタデータの取得 以下に示すように、getTable()メソッドを使用して、テーブル名でプロジェクト内のNoSQLテーブルのメタデータを取得できます。 // NoSQLインスタンスを作成 const nosql = app.nosql(); // テーブル名を使用してテーブルメタデータを取得する const tableB = await nosql.getTable('EmpTable'); Note: テーブル名を変更した場合、コード内の変更を更新する必要があります。 <br> ### すべてのテーブルのメタデータの取得 Catalystでは、以下に示すようにgetAllTable()メソッドを使用して、プロジェクト内のすべてのテーブルのメタデータを取得できます。 // すべてのテーブルのメタデータを取得 const allTables = await nosql.getAllTable(); -------------------------------------------------------------------------------- title: "テーブルインスタンスの取得" description: "Catalyst NoSQLは、非リレーショナルでNoSQLのデータストレージを提供する、完全マネージドで強力なデータベースです。このページでは、NoSQLテーブルインスタンスを作成するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.329Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/nosql/get-table-instance/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Create and Manage Tables (/ja/cloud-scale/help/nosql/create-manage-tables/) -------------------------------------------------------------------------------- # NoSQLテーブルインスタンスの取得 Catalyst NoSQLを使用すると、既存のNoSQLテーブルの空のテーブルインスタンスを取得できます。このインスタンスを使用してそのテーブルを参照し、サポートされているすべてのテーブル操作を実行できます。このプロセスはサーバーサイドの呼び出しを発生させません。 このセクションで説明する3つの方法でNoSQLテーブルのインスタンスを取得できます。以下のコードスニペットで使用されているnosqlの参照は、先に作成したコンポーネントインスタンスです。 ### テーブルIDによるインスタンスの取得 以下に示すように、テーブルの一意のIDでテーブルインスタンスを取得します。 const tableInstanceA = nosql.table('1234567890'); // テーブルIDでテーブルインスタンスを作成する <br> ### テーブル名によるインスタンスの取得 以下に示すように、テーブル名でテーブルインスタンスを取得します。 const tableInstanceB = nosql.table('Emptable'); // テーブル名でテーブルインスタンスを作成 <br> ### テーブル詳細によるインスタンスの取得 以下に示すように、テーブルの詳細を指定し、toJSON()に解決してテーブルインスタンスを取得します。 このメソッドは、テーブルIDまたはテーブル名を使用して既にインスタンスを取得したテーブルオブジェクトを複製する柔軟性を提供します。その後、インスタンスにテーブルの追加の詳細を設定し、代わりにこれを使用してテーブルを参照できます。 const tableInstanceC = nosql.table(tableA.toJSON()); // テーブル詳細でテーブルインスタンスを作成 -------------------------------------------------------------------------------- title: "NoSQL アイテムの構築" description: "Catalyst NoSQLは、非リレーショナルでNoSQLのデータストレージを提供する、完全マネージドで強力なデータベースです。このページでは、さまざまなデータ型のNoSQLアイテムを構築するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.329Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/nosql/construct-item/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Basic Components (/ja/cloud-scale/help/nosql/components/#basic-components) - Supported Data Types in NoSQL (/ja/cloud-scale/help/nosql/working-with-data/introduction/) -------------------------------------------------------------------------------- # NoSQLアイテムの構築 Catalyst NoSQLのアイテムは、単一のデータポイント（レコードのようなもの）のデータを保持する属性のコレクションを表します。プロジェクト内の既存のNoSQLテーブルに、カスタムJSON形式でアイテムを挿入または更新できます。ただし、Catalystでアイテムを挿入または更新する前に、アイテムを構築する必要があります。 以下のセクションで説明するように、Catalystがサポートするさまざまなデータ型の属性を含むNoSQLアイテムを構築できます。Catalystは、String、Number、Set of Strings、Set of Numbers、List、Mapなど、いくつかのデータ型をサポートしています。サポートされているデータ型の完全なリストを参照してください。 テーブルに設定したパーティションキー属性の値は、すべてのデータアイテムで必ず提供する必要があります。テーブルキー、TTL属性、その他の詳細については、テーブルキーのヘルプセクションを参照してください。 <br> ### 新しいNoSQLアイテムの作成 以下に示すように、zcatalyst-sdk-nodeパッケージの一部であるno-sqlライブラリをrequireした後、NoSQLItem()メソッドを使用して新しいNoSQLアイテムを作成できます。 const { NoSQLItem } = require('zcatalyst-sdk-node/lib/no-sql'); const item = new NoSQLItem() // 新しいNoSQLアイテムを作成 <br> ### 文字列のNoSQLアイテムの構築 以下の例では、文字列値とネストされたJSON属性colorをMapとして含むアイテムを構築します。 const { NoSQLItem } = require('zcatalyst-sdk-node/lib/no-sql'); const item = new NoSQLItem() // 新しいNoSQLアイテムを作成 // 文字列値を追加する .addString('fruit', 'mango') // マップを追加する .addMap('properties', { color: 'yellow' }); <br> ### NoSQLバイトの構築 バイトのシーケンスを表すために使用されるバッファオブジェクトを作成し、*Binary*データ型の値を格納するNoSQLバイトを作成できます。以下に示すように、生のバイナリデータバッファを表すArrayBuffersオブジェクトを使用するか、ASCII形式でバイナリデータを表すBase64文字列から、2つの方法でバイトを作成できます。 const { NoSQLByte } = require('zcatalyst-sdk-node/lib/no-sql'); // NoSQL Byteを作成する const buff = Buffer.from('Hello world !!!'); // バッファオブジェクトを作成 const byte = new NoSQLByte(buff); // ArrayBuffersオブジェクトを使用してNoSQLバイトを作成 const byteA = new NoSQLByte(buff.toString('base64')); // Base64文字列からNoSQLバイトを作成 <br> ### NoSQLバイトセットの構築 Catalystでは、バイトのシーケンスを表すために使用されるバッファオブジェクトを作成し、*Set of Binary*データ型のバイナリ値のコレクションを格納するNoSQLバイトセットを作成できます。生のバイナリデータバッファを表すArrayBuffersオブジェクトを使用するか、ASCII形式でバイナリデータを表すBase64文字列からバイトセットを作成できます。 また、構築済みのバイトをバイト配列として渡すことで、バイトセットを作成することもできます。 const { NoSQLByte, NoSQLByteSet } = require('zcatalyst-sdk-node/lib/no-sql'); // NoSQL Byte Setを作成する const buff = Buffer.from('Hello world !!!'); // バッファオブジェクトを作成 const byte = new NoSQLByte(buff); // ArrayBuffersオブジェクトを使用してNoSQLバイトを作成 const byteA = new NoSQLByte(buff.toString('base64')); // Base64文字列からNoSQLバイトを作成 const byteSet = new NoSQLByteSet([byte, byteA]); // NoSQLバイト配列からNoSQLバイトセットを作成 const byteSetA = new NoSQLByteSet([buff.toString('base64')]); // NoSQL Byteを作成する set from a Base64 string array const byteSetB = new NoSQLByteSet([buff]); // NoSQL Byteを作成する set using the ArrayBuffers object <br> ### NoSQL文字列セットの構築 以下に示すように、文字列配列から*Set of String*データ型のNoSQL文字列セットを作成できます。 const { NoSQLStringSet } = require('zcatalyst-sdk-node/lib/no-sql'); // NoSQL string setを作成する const stringSet = new NoSQLStringSet(['hello', 'world']); // NoSQL string setを作成する from a string array <br> ### NoSQL数値セットの構築 以下に示すように、数値またはBigInt値の配列から*Set of Numbers*データ型のNoSQL数値セットを作成できます。 const { NoSQLNumberSet } = require('zcatalyst-sdk-node/lib/no-sql'); // NoSQL number setを作成する const numberSet = new NoSQLNumberSet([123, 1234n]); // 数値またはBigInt値の配列からNoSQL数値セットを作成 <br> ### NoSQLアイテムの操作 Catalystでは、NoSQLアイテムに対して、プレーンJavaScriptオブジェクトからNoSQLアイテムを作成する、またはその逆の操作などの操作を実行できます。アイテムのデータを標準JSON形式で含むプレーンJavaScriptオブジェクトを構築して、NoSQLアイテムを作成できます。以下のサンプルコードに示すように、NoSQLItem.from()を使用してJSオブジェクトからNoSQLアイテムを構築できます。 また、コードに示すように、itemFromObj.to()を使用してNoSQLアイテムをプレーンJavaScriptオブジェクトに戻すこともできます。 const { NoSQLItem } = require('zcatalyst-sdk-node/lib/no-sql'); // オブジェクトを定義する const obj = { fruit: 'apple', // パーティションキー properties: { color: 'red' } }; const itemFromObj = NoSQLItem.from(obj); // プレーンJSオブジェクトからNoSQLアイテムを構築 const plainJsObject = itemFromObj.to(); // アイテムをプレーンJSオブジェクトに変換 -------------------------------------------------------------------------------- title: "テーブルへのアイテムの挿入" description: "Catalyst NoSQLは、非リレーショナルかつ非SQLのデータストレージ手段を提供する、フルマネージドで強力なデータベースです。このページでは、NoSQLテーブルにさまざまな方法でアイテムを挿入するためのSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.330Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/nosql/insert-items/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Working with Data (/ja/cloud-scale/help/nosql/working-with-data/introduction/) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/insert-item/#InsertNewItem) -------------------------------------------------------------------------------- # NoSQLテーブルへのアイテムの挿入 Catalystでは、アイテムを構築した後、特定のNoSQLテーブルにアイテムを挿入できます。このセクションで説明するさまざまな方法でアイテムを挿入できます。 データの追加と操作に関するヘルプセクション、CatalystカスタムJSON形式、およびサポートされるデータ型を参照して、これらのトピックの詳細を確認できます。 Note: Catalystでは、1回のSDK操作でNoSQLテーブルに最大25件のアイテムを一括挿入できます。 <br> ### 条件なしでのアイテムの挿入 CatalystカスタムJSON形式でアイテムを構築することで、条件なしでNoSQLテーブルに新しいアイテムを挿入できます。この場合、テーブルに設定されたパーティションキーとソートキー属性の値を必須で渡す必要があります。 以下の例では、パーティションキー属性fruitNameの値を「Banana」として含むアイテムが提供されています。文字列データ型の他の属性（fruitColorやfruitTypeなど）も、fruitPropertiesというマップとして追加されています。アイテムはinsertItems()メソッドを使用して挿入されます。 // 条件なしでNoSQLアイテムを挿入 const plainInsert = await table.insertItems({ // 挿入するアイテムを定義する with the partition key fruitName item: NoSQLItem.from({ fruitName: 'Banana', //アイテムの他の属性の値を指定する fruitProperties: { fruitColor: 'Yellow', fruitType: 'Berries' } }), // レスポンスの戻り値を設定する。その他のサポート値は"OLD"と"NULL" return: NoSQLReturnValue.NEW }); <br> ### 条件付き関数でのアイテムの挿入 CatalystカスタムJSON形式で定義した特定の条件を使用して、NoSQLテーブルの既存アイテムに属性を挿入できます。この方法では、テーブルの既存データが取得され、指定された条件に対して評価されます。評価が真の場合にのみアイテムが挿入されます。既存データがない場合、条件は無視されアイテムが挿入されます。 Catalystでは、条件を評価するための複数の演算子がサポートされています。サポートされる演算子は以下のとおりです。 <table class="content-table nosql-components-table"> <thead> <tr> <th class="w10p">Operators</th> <th class="w10p">Notation</th> </tr> </thead> <tbody> <tr> <td>CONTAINS</td> <td>contains</td> </tr> <tr> <td>NOT_CONTAINS</td> <td>not_contains</td> </tr> <tr> <td>BEGINS_WITH</td> <td>begins_with</td> </tr> <tr> <td>ENDS_WITH</td> <td>ends_with</td> </tr> <tr> <td>IN</td> <td>in</td> </tr> <tr> <td>NOT_IN</td> <td>not_in</td> </tr> <tr> <td>BETWEEN</td> <td>between</td> </tr> <tr> <td>NOT_BETWEEN</td> <td>not_between</td> </tr> <tr> <td>EQUALS</td> <td>equals</td> </tr> <tr> <td>NOT_EQUALS</td> <td>not_equals</td> </tr> <tr> <td>GREATER_THAN</td> <td>greater_than</td> </tr> <tr> <td>LESS_THAN</td> <td>less_than</td> </tr> <tr> <td>GREATER_THAN_OR_EQUALS</td> <td>greater_equal</td> </tr> <tr> <td>LESSER_THAN_OR_EQUALS</td> <td>less_equal</td> </tr> <tr> <td>AND</td> <td>AND</td> </tr> <tr> <td>OR</td> <td>OR</td> </tr> </tbody> </table> <br> 以下の例では、既存データ内の属性fruitNameのデータ型がStringであることを条件として定義しています。条件が満たされた場合、これらのアイテムに値「Sweet」を持つ属性tasteが追加されます。 // "attribute_type"関数でNoSQLアイテムを挿入 const attrTypeInsert = await table.insertItems({ // 挿入するアイテムを定義する item: NoSQLItem.from({ taste: 'Sweet' }), // 挿入の条件を定義する condition: { // 条件は属性タイプがString（"S"）の場合にアイテムを追加することを指定する function: { // 関数タイプを設定する function_name: 'attribute_type', // 関数に引数を渡す args: [ { // 属性パスを設定する attribute_path: ['fruitName'] }, // 属性タイプを設定する NoSQLMarshall.makeString('S') // => { "S": "S" } ] } } }); <br> 以下は、条件付き関数を使用してアイテムを挿入するその他のサンプルスニペットです。 //"equals"演算子を使用し、属性"name"の値が"apple"のNoSQLアイテムを挿入する const operatorEqInsert = await table.insertItems({ // 挿入するアイテムを定義する item: NoSQLItem.from({ taste: 'Sweet' }), // 挿入の条件を定義する condition: { // 属性パスを設定する attribute: ['name'], // 操作に基づいて演算子を設定する operator: NoSQLOperator.EQUALS, // 比較する値を設定する value: NoSQLMarshall.makeString('apple') // => { "S": "apple" } } }); //「group_operator」でNoSQLアイテムを挿入する。属性「name」が「apple」かつ属性「variety」が「gala」 const groupOpInsert = await table.insertItems({ // 挿入するアイテムを定義する item: NoSQLItem.from({ taste: 'Sweet' }), // 挿入の条件を定義する condition: { // グループ演算子を設定する group_operator: NoSQLConditionGroupOperator.AND, // グループ条件を指定する group: [ { // 属性パスを設定する attribute: 'name', // 操作に基づいて演算子を設定する operator: NoSQLOperator.EQUALS, // 比較する値を設定する value: NoSQLMarshall.makeString('apple') // => { "S": "apple" } }, { // 属性パスを設定する attribute: 'variety', // 操作に基づいて演算子を設定する operator: NoSQLOperator.EQUALS, // 比較する値を設定する value: NoSQLMarshall.makeString('gala') // => { "S": "gala" } } ] } }); //「begins_with」演算子でNoSQLアイテムを挿入する。属性「name」の値が「app」で始まる const beginsWithInsert = await table.insertItems({ // 挿入するアイテムを定義する item: NoSQLItem.from({ taste: 'Sweet' }), // 挿入の条件を定義する condition: { // 属性パスを設定する attribute: ['name'], // 操作に基づいて演算子を設定する operator: NoSQLOperator.BEGINS_WITH, // 比較する値を設定する value: NoSQLMarshall.makeString('app') // => { "S": "app" } } }); -------------------------------------------------------------------------------- title: "テーブル内のアイテムの更新" description: "Catalyst NoSQLは、非リレーショナルかつ非SQLのデータストレージ手段を提供する、フルマネージドで強力なデータベースです。このページでは、NoSQLテーブル内のアイテムを更新するためのSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.330Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/nosql/update-items/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Working with Data (/ja/cloud-scale/help/nosql/working-with-data/introduction/) - Basic Components (/ja/cloud-scale/help/nosql/components/#basic-components) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/update-item/#UpdateItem) -------------------------------------------------------------------------------- # テーブル内のアイテムの更新 Catalystでは、アイテムを構築した後、特定のNoSQLテーブル内のアイテムを更新できます。アイテムは、そのプライマリキーを使用して識別することで更新できます。たとえば、パーティションキーのみ、またはパーティションキーとソートキーの組み合わせを使用してアイテムを識別できます。 次に、適切なHTTPリクエストメソッドで更新操作の種類を定義し、アイテム内で更新する属性と値を指定します。 Note: Catalystでは、1回のSDK操作でNoSQLテーブル内の最大25件のアイテムを一括更新できます。 以下の例では、パーティションキーfruitNameと値「Apple」でアイテムを識別しています。更新対象のアイテムの属性colorとtasteの値が、これらの属性へのパスとともに提供されています。 zcatalyst-sdk-node packageのno-sqlライブラリは、NoSQLアイテムの定義と構築に必要です。 const { NoSQLItem, NoSQLEnum } = require('zcatalyst-sdk-node/lib/no-sql'); const { NoSQLOperator } = NoSQLEnum; // パーティションキー「apple」で識別されるNoSQLアイテムのプロパティ属性を更新する const updatedItems = await table.updateItems({ // 更新するアイテムのパーティションキー値を定義する keys: [new NoSQLItem().addString('fruit', 'apple')], // 更新する属性を定義する update_attributes: [ { // 更新操作のタイプを指定する operation_type: NoSQLUpdateOperationType.PUT, // 更新する属性の値を指定する update_value: NoSQLMarshall.makeMap({ color: 'Green', taste: 'Sour' }), // 属性へのパスを指定する attribute_path: ['fruitProperties'] } ] }); -------------------------------------------------------------------------------- title: "テーブルからのアイテムの取得" description: "Catalyst NoSQLは、非リレーショナルかつ非SQLのデータストレージ手段を提供する、フルマネージドで強力なデータベースです。このページでは、NoSQLテーブルからアイテムを取得するためのSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.330Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/nosql/fetch-items/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Basic Components (/ja/cloud-scale/help/nosql/components/#basic-components) - Working with Data (/ja/cloud-scale/help/nosql/working-with-data/introduction/) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/fetch-item/#FetchItem) -------------------------------------------------------------------------------- # NoSQLテーブルからのアイテムの取得 Catalystでは、NoSQLテーブルから、プライマリキーを使用してアイテムを識別し、取得できます。たとえば、パーティションキーのみ、またはパーティションキーとソートキーの組み合わせを使用してアイテムを取得できます。また、必要な属性を指定して、取得する属性をオプションでフィルタリングすることもできます。 Note: Catalystでは、1回のSDK読み取り操作でNoSQLテーブルから最大100件のアイテムを取得できます。 以下の例では、fetchItem()を使用して、パーティションキーfruitの値が「apple」であるアイテムを取得しています。required_attributesを使用して、propertiesやtasteなどの特定の属性がフィルタリングされて取得されます。 このコードスニペットでは、consistent_readを使用して、読み取り操作をマスタークラスターまたはスレーブクラスターのどちらで実行するかを指定しています。trueに設定すると、マスターからクエリされます。falseの場合、スレーブからクエリされます。 Note: マスター・スレーブレプリケーションでは、マスターにはデータベースのすべてのデータが含まれ、スレーブにはマスターからのコピーが含まれます。スレーブから読み取り操作を実行すると、更新されたデータの反映にわずかな遅延が生じるというトレードオフがありますが、全体的なコストを削減できます。 zcatalyst-sdk-nodeパッケージのno-sqlライブラリは、NoSQLアイテムの定義に必要です。 const { NoSQLItem } = require('zcatalyst-sdk-node/lib/no-sql'); //パーティションキー値「apple」で識別されるNoSQLItemのプロパティを取得する const fetchedItem = await table.fetchItem({ // 取得するアイテムのパーティションキーと値を定義する keys: [new NoSQLItem().addString('fruit', 'apple')], // consistent_readをtrueに設定してマスターからクエリする。falseに設定するとスレーブからクエリされる。 consistent_read: true, // 取得する属性を指定する required_attributes: [['properties', 'taste']] }); -------------------------------------------------------------------------------- title: "テーブルのクエリ" description: "Catalyst NoSQLは、非リレーショナルかつ非SQLのデータストレージ手段を提供する、フルマネージドで強力なデータベースです。このページでは、NoSQLテーブルをクエリするためのSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.330Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/nosql/query-table/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Table Keys (/ja/cloud-scale/help/nosql/components/#table-keys) - Query Table (/ja/sdk/nodejs/v2/cloud-scale/nosql/query-table/) -------------------------------------------------------------------------------- # NoSQLテーブルのクエリ Catalystでは、NoSQLテーブルをクエリし、テーブルのプライマリキーを使用してアイテムを識別することでデータを取得できます。たとえば、パーティションキーのみ、またはパーティションキーとソートキーの組み合わせを使用してアイテムを取得できます。 Note: Catalystでは、1回のSDK操作でNoSQLテーブルからページネーション付きで最大100件のアイテムを一括取得できます。SDKレスポンスで受信したstart_keyトークンを使用して、ページネーションのロジックを構築する必要があります。 属性、必要な値、および使用するサポートされる演算子を指定して、アイテムを識別するキー条件を定義できます。サポートされる演算子は以下のとおりです。 <table class="content-table nosql-components-table"> <thead> <tr> <th class="w10p">Operators</th> <th class="w10p">Notation</th> </tr> </thead> <tbody> <tr> <td>CONTAINS</td> <td>contains</td> </tr> <tr> <td>NOT_CONTAINS</td> <td>not_contains</td> </tr> <tr> <td>BEGINS_WITH</td> <td>begins_with</td> </tr> <tr> <td>ENDS_WITH</td> <td>ends_with</td> </tr> <tr> <td>IN</td> <td>in</td> </tr> <tr> <td>NOT_IN</td> <td>not_in</td> </tr> <tr> <td>BETWEEN</td> <td>between</td> </tr> <tr> <td>NOT_BETWEEN</td> <td>not_between</td> </tr> <tr> <td>EQUALS</td> <td>equals</td> </tr> <tr> <td>NOT_EQUALS</td> <td>not_equals</td> </tr> <tr> <td>GREATER_THAN</td> <td>greater_than</td> </tr> <tr> <td>LESS_THAN</td> <td>less_than</td> </tr> <tr> <td>GREATER_THAN_OR_EQUALS</td> <td>greater_equal</td> </tr> <tr> <td>LESSER_THAN_OR_EQUALS</td> <td>less_equal</td> </tr> <tr> <td>AND</td> <td>AND</td> </tr> <tr> <td>OR</td> <td>OR</td> </tr> </tbody> </table> <br> 以下の例では、パーティションキーfruitTypeを使用してアイテムを識別し、条件値を「Citrus」として指定して、queryTable()メソッドでクエリを実行しています。 Catalyst NoSQLでは、consistent_readを使用して読み取り操作をマスタークラスターまたはスレーブクラスターのどちらで実行するかを指定したり、返される行数を制限したり、昇順のソート順序を指定するなど、クエリの他の要素も定義できます。 Note: マスター・スレーブレプリケーションでは、マスターにはデータベースのすべてのデータが含まれ、スレーブにはマスターからのコピーが含まれます。スレーブから読み取り操作を実行すると、更新されたデータの反映にわずかな遅延が生じるというトレードオフがありますが、全体的なコストを削減できます。 zcatalyst-sdk-nodeパッケージのno-sqlライブラリは、NoSQLアイテムの定義に必要です。 const { NoSQLMarshall, NoSQLEnum } = require('zcatalyst-sdk-node/lib/no-sql'); const { NoSQLOperator } = NoSQLEnum; // パーティションキーfruitTypeの値「citrus」で識別されるアイテムを取得するためにNoSQLテーブルをクエリする const queriedItem = await table.queryTable({ // アイテムをクエリするためのキー条件を定義する key_condition: { // テーブルのパーティションキー属性名を指定する attribute: 'fruitType', // 使用するサポートされた演算子を定義する。BETWEEN、GREATERTHAN、LESSERTHAN、GREATERTHANOREQUALTO、LESSERTHANOREQUALTOも使用可能 operator: NoSQLOperator.EQUALS, // 比較する値を指定する value: NoSQLMarshall.makeString('Citrus') }, // consistent_readをtrueに設定してマスターからクエリする。falseに設定するとスレーブからクエリされる。 consistent_read: true, // 値を指定して返される行数を制限する limit: 10, // forward_scanをtrueに設定して結果を昇順にソートする。それ以外の場合は降順にソートされる。 forward_scan: true }); -------------------------------------------------------------------------------- title: "インデックスのクエリ" description: "Catalyst NoSQLは、非リレーショナルかつ非SQLのデータストレージ手段を提供する、フルマネージドで強力なデータベースです。このページでは、NoSQLインデックスをクエリするためのSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.330Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/nosql/query-index/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Table Keys (/ja/cloud-scale/help/nosql/components/#table-keys) - Query Index (/ja/sdk/nodejs/v2/cloud-scale/nosql/query-index/) -------------------------------------------------------------------------------- # NoSQLでのインデックスのクエリ Catalystでは、NoSQLインデックスをクエリし、インデックスのプライマリキーを使用してアイテムを識別することでデータを取得できます。インデックスを使用すると、メインテーブルのプライマリキーを使用せずにテーブルデータに対して代替クエリを実行できます。インデックスはCatalystコンソールから設定できます。インデックスのパーティションキーのみ、またはパーティションキーとソートキーの組み合わせを使用してアイテムを取得できます。 Note: Catalystでは、1回のSDK操作でNoSQLテーブルからページネーション付きで最大100件のアイテムを一括取得できます。SDKレスポンスで受信したstart_keyトークンを使用して、ページネーションのロジックを構築する必要があります。 属性、必要な値、および使用するサポートされる演算子を指定して、アイテムを識別するキー条件を定義できます。サポートされる演算子は以下のとおりです。 <table class="content-table nosql-components-table"> <thead> <tr> <th class="w10p">Operators</th> <th class="w10p">Notation</th> </tr> </thead> <tbody> <tr> <td>CONTAINS</td> <td>contains</td> </tr> <tr> <td>NOT_CONTAINS</td> <td>not_contains</td> </tr> <tr> <td>BEGINS_WITH</td> <td>begins_with</td> </tr> <tr> <td>ENDS_WITH</td> <td>ends_with</td> </tr> <tr> <td>IN</td> <td>in</td> </tr> <tr> <td>NOT_IN</td> <td>not_in</td> </tr> <tr> <td>BETWEEN</td> <td>between</td> </tr> <tr> <td>NOT_BETWEEN</td> <td>not_between</td> </tr> <tr> <td>EQUALS</td> <td>equals</td> </tr> <tr> <td>NOT_EQUALS</td> <td>not_equals</td> </tr> <tr> <td>GREATER_THAN</td> <td>greater_than</td> </tr> <tr> <td>LESS_THAN</td> <td>less_than</td> </tr> <tr> <td>GREATER_THAN_OR_EQUALS</td> <td>greater_equal</td> </tr> <tr> <td>LESSER_THAN_OR_EQUALS</td> <td>less_equal</td> </tr> <tr> <td>AND</td> <td>AND</td> </tr> <tr> <td>OR</td> <td>OR</td> </tr> </tbody> </table> <br> 以下の例では、インデックスFruitIdentifierのパーティションキーfruitColorを使用してアイテムを識別し、条件値を「yellow」として指定してクエリを実行しています。クエリはqueryIndex()メソッドを使用して実行されます。 Catalyst NoSQLでは、consistent_readを使用して読み取り操作をマスタークラスターまたはスレーブクラスターのどちらで実行するかを指定したり、返される行数を制限したり、昇順のソート順序を指定するなど、クエリの他の要素も定義できます。 Note: マスター・スレーブレプリケーションでは、マスターにはデータベースのすべてのデータが含まれ、スレーブにはマスターからのコピーが含まれます。スレーブから読み取り操作を実行すると、更新されたデータの反映にわずかな遅延が生じるというトレードオフがありますが、全体的なコストを削減できます。 zcatalyst-sdk-nodeパッケージのno-sqlライブラリは、NoSQLアイテムの定義に必要です。 const { NoSQLMarshall, NoSQLEnum } = require('zcatalyst-sdk-node/lib/no-sql'); const { NoSQLOperator } = NoSQLEnum; //パーティションキーfruitColourの値「yellow」で識別されるアイテムを取得するためにNoSQLテーブルインデックスをクエリする const queriedIndexItems = await table.queryIndex('FruitIdentifier', { //アイテムをクエリするためのキー条件を定義する key_condition: { attribute: 'fruitColor', //使用するサポートされた演算子を定義する operator: NoSQLOperator.EQUALS, value: NoSQLMarshall.makeString('yellow') }, // consistent_readをtrueに設定してマスターからクエリする。falseに設定するとスレーブからクエリされる。 consistent_read: true, //値を指定して返される行数を制限する limit: 15, // forward_scanをtrueに設定して結果を昇順にソートする。それ以外の場合は降順にソートされる。 forward_scan: true }); -------------------------------------------------------------------------------- title: "テーブルからのアイテムの削除" description: "Catalyst NoSQLは、非リレーショナルかつ非SQLのデータストレージ手段を提供する、フルマネージドで強力なデータベースです。このページでは、NoSQLテーブルからアイテムを削除するためのSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.331Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/nosql/delete-items/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Working with Data (/ja/cloud-scale/help/nosql/working-with-data/introduction/) - Basic Components (/ja/cloud-scale/help/nosql/components/#basic-components) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/delete-item/#DeleteItem) -------------------------------------------------------------------------------- # NoSQLテーブルからのアイテムの削除 Catalystでは、テーブルのプライマリキーを使用してアイテムを識別することで、NoSQLテーブルからアイテムを削除できます。たとえば、パーティションキーのみ、またはテーブルのパーティションキーとソートキーの組み合わせを使用してアイテムを識別します。 Note: Catalystでは、1回のSDK操作でNoSQLテーブルから最大25件のアイテムを一括削除できます。 削除操作は、以下の例に示すようにdeleteItems()メソッドを使用して実行されます。パーティションキーfruitが「apple」に一致するアイテムが削除されます。zcatalyst-sdk-node packageのno-sql libraryは、NoSQLアイテムの定義に必要です。 const { NoSQLItem } = require('zcatalyst-sdk-node/lib/no-sql'); //パーティションキー「fruit」で値が「apple」に一致するNoSQLアイテムをテーブルから削除する const deletedItems = await table.deleteItems({ //削除するアイテムのパーティションキー値を指定する keys: NoSQLItem.from({ fruit: 'apple' }) }); ##### Stratus -------------------------------------------------------------------------------- title: "概要" description: "このページでは、コードを通じてStratus操作を実行するために必要なすべてのNode.js SDKメソッドを一覧で紹介します。" last_updated: "2026-06-10T06:04:54.331Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/overview/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/overview/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/overview/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Stratus ## 概要 Cloud Scale Stratusは、Catalystの堅牢で強力なストレージソリューションです。Bucketsと呼ばれるコンテナ内に、Objectsの形式であらゆる形式のデータを保存できます。各Bucketおよびバケット内のすべてのオブジェクトには、安全なObject URLとBucket URLがあります。オブジェクトに対してアップロードおよびダウンロード操作を実行でき、各オブジェクトにカスタム権限を提供することもできます。 以下の表には、コードを通じてStratus操作を実行するために使用できるすべてのCatalyst SDKの一覧が含まれています。 <table class="content-table"> <thead> <tr> <th class="w30p">Category</th> <th class="w70p">SDK Method</th> </tr> </thead> <tbody> <tr> <td>General Stratus Operations</td> <td> <ul> <li>Create Stratus Instance</li> <li>Check Bucket Availability</li> <li>List Buckets</li> </ul> </td> </tr> <tr> <td>Bucket Operations</td> <td> <ul> <li>Create Bucket Instance</li> <li>Get Bucket Details</li> <li>Get Bucket CORS</li> <li>List Objects in a Bucket <ul> <li>List all Objects by Pagination</li> <li>List Objects Through Iteration</li> </ul> </li> <li>Check Object Availability</li> <li>Download Object <ul> <li>Download an Object</li> <li>Download a Portion of the Object</li> <li>Download an Object Using Transfer Manager</li> <li>Generate Presigned URL to Download an Object</li> </ul> </li> <li>Upload Object <ul> <li>Upload Object as a Stream</li> <li>Upload Object as a String</li> <li>Upload Object with Options</li> <li>Upload Object Using Multipart</li> <li>Upload an Object Using Transfer Manager</li> <li> Generate Presigned URL to Upload an Object</li> </ul> </li> <li>Extract a Zipped Object In Stratus <ul> <li>Get Zip Extraction Status</li> </ul> </li> <li>Copy Object</li> <li>Rename and Move Operations on an Object</li> <li>Delete Objects <ul> <li>Delete a Single Object</li> <li>Delete a Specific Version of an Object after a Specific Time</li> <li>Delete Multiple Objects</li> <li>Truncate Bucket</li> <li>Delete a Path in the Bucket</li> </ul> </li> </ul> </td> </tr> <tr> <td>Object Operations</td> <td> <ul> <li>Create Object Instance</li> <li>List Object Versions <ul> <li>List All Versions of an Object Through Pagination</li> <li>List All Versions of the Object Through Iteration</li> </ul> </li> <li>Get Object Details <ul> <li>Get Details of All Objects</li> <li>Get Details of a Particular Version of the Object</li> </ul> </li> <li>Put Object Meta Data</li> </ul> </td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "Stratusインスタンスの作成" description: "このページでは、Stratusインスタンスを作成するためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.332Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/create-stratus-instance/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/create-stratus-instance/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/create-stratus-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/initialize-stratus-instance/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/create-bucket-instance/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/initialize-stratus/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Stratusインスタンスの作成 以下に示すように、stratusコンポーネントの参照を取得できます。これはサーバーサイドの呼び出しを発生させません。このコンポーネントインスタンスは、Stratusを使用するさまざまなコードスニペットで参照されます。 // Stratusインスタンスを取得 const stratus = app.stratus(); -------------------------------------------------------------------------------- title: "Bucketの存在確認" description: "このページでは、プロジェクト内にBucketが存在するかどうかを確認するためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.332Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/check-bucket/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/check-bucket/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/check-bucket/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/check-bucket/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Bucketの存在確認 headBucket() SDKメソッドを使用すると、Stratus内のBucketの存在を確認し、さらにユーザーがBucket内のオブジェクトにアクセスするための適切な権限を持っているかどうかを確認できます。以下のコードスニペットで使用されているStratus参照は、コンポーネントインスタンスです。 このSDKを使用した場合のレスポンスは以下のとおりです： * Bucketが存在し、ユーザーがBucketにアクセスするための適切な権限を持っている場合、レスポンス「**true**」が返されます。 * Bucketが存在しない場合、またはユーザーがBucketにアクセスする権限を持っていない場合、レスポンス「**false**」が返されます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">Parameter Name</th> <th class="w20p">Data Type</th> <th class="w60p">Definition</th> </tr> </thead> <tbody> <tr> <td>bucketName</td> <td>String</td> <td>必須パラメータです。Bucketの一意の名前を保持します。</td> </tr> <tr> <td>throwErr</td> <td>Boolean</td> <td>任意パラメータです。このパラメータを「true」に設定すると、プロジェクト内にBucketが見つからない場合にエラーをスローします。デフォルト値は「false」です。</td> </tr> </tbody> </table> const headBucketResponse = await stratus.headBucket('bucketName'); // バケットがStratusで利用可能か確認 console.log(headBucketResponse); **発生する可能性のあるエラー** Note: throw_errパラメータを指定してSDKを使用し、Bucketが存在しない場合、または十分な権限がない場合、以下に記載されたエラーのいずれかが発生する可能性があります。 <table class="content-table"> <thead> <tr> <th class="w30p">Error Code</th> <th class="w70p">Meaning</th> </tr> </thead> <tbody> <tr> <td>404</td> <td>Not Found。Stratus内にBucketが見つかりません。</td> </tr> <tr> <td>401</td> <td>Unauthorized/Access Denied - ユーザーに特定の操作を実行する権限がありません。</td> </tr> <tr> <td>403</td> <td>Permission Denied - ユーザーに特定のBucketにアクセスする権限がありません。</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "Bucketsの一覧取得" description: "このページでは、プロジェクト内に作成されたBucketsを一覧取得するためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.332Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/list-buckets/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/list-buckets/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/list-buckets/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Bucketsの一覧取得 以下のSDKメソッドは、プロジェクト内に存在するすべてのBucketsを返します。以下のコードスニペットで使用されているStratus参照は、コンポーネントインスタンスです。 const responses= await stratus.listBuckets(); // すべてのバケットを返す console.log(responses); Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 #### レスポンス例 [ { "bucket_name": "zcstratus122", "project_details": { "project_name": "Learn", "id": "6759000000014001", "project_type": "Live" }, "created_by": { "zuid": "74660608", "is_confirmed": "False", "email_id": "emmy@zylker.com", "first_name": "Amelia Burrows", "last_name": "C", "user_type": "Admin", "user_id": "6759000000009004" }, "created_time": "Mar 26, 2024 12:44 PM", "modified_by": { "zuid": "74660608", "is_confirmed": "False", "email_id": "emmy@zylker.com", "first_name": "Amelia Burrows", "last_name": "C", "user_type": "Admin", "user_id": "6759000000009004" }, "modified_time": "Mar 30, 2024 11:38 AM", "bucket_meta": { "versioning": "False", "caching": { "status": "Enabled", "delivery_point_id": "01ht6zj7k536c29ymsgfeky1mg" }, "encryption": "False", "audit_consent": "False" }, "bucket_url": "https://zcstratus122-development.zohostratus.com" }, { "bucket_name": "zcstratus12345", "project_details": { "project_name": "Learn", "id": "6759000000014001", "project_type": "Live" }, "created_by": { "zuid": "74660608", "is_confirmed": "False", "email_id": "emmy@zylker.com", "first_name": "Amelia Burrows", "last_name": "C", "user_type": "Admin", "user_id": "6759000000009004" }, "created_time": "Mar 13, 2024 05:51 PM", "modified_by": { "zuid": "74660608", "is_confirmed": "False", "email_id": "emmy@zylker.com", "first_name": "Amelia Burrows", "last_name": "C", "user_type": "Admin", "user_id": "6759000000009004" }, "modified_time": "Apr 18, 2024 12:44 PM", "bucket_meta": { "versioning": "True", "caching": { "status": "Enabled", "delivery_point_id": "01hrxy25tv1vex73qhm85g88bf" }, "encryption": "False", "audit_consent": "False" }, "bucket_url": "https://zcstratus12345-development.zohostratus.com" } ] -------------------------------------------------------------------------------- title: "Bucketインスタンスの作成" description: "このページでは、Bucketインスタンスを作成するためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.333Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/create-bucket-instance/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Create a Bucket Help Documentation (/ja/cloud-scale/help/stratus/buckets/create-bucket/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/create-bucket-instance/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/create-bucket-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Bucketインスタンスの作成 バケットレベルの操作を実行するには、Bucketインスタンスを作成する必要があります。このコンポーネントインスタンスは、StratusのBucketsを使用するさまざまなコードスニペットで参照されます。 const bucket = stratus.bucket("bucketName"); -------------------------------------------------------------------------------- title: "Bucket詳細の取得" description: "このページでは、Bucketのすべての詳細情報を取得するためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.333Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/get-bucket-details/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Create a Bucket Help Documentation (/ja/cloud-scale/help/stratus/buckets/create-bucket/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/create-bucket-instance/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/create-bucket-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Bucket詳細の取得 以下のSDKメソッドを使用すると、特定のBucketのすべての利用可能な詳細情報を取得できます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 const buckets = await bucket.getDetails(); // 指定されたバケットの詳細を取得 console.log(buckets); #### レスポンス例 { "bucket_name": "zcstratus122", "project_details": { "project_name": "Learn", "id": "6759000000014001", "project_type": "Live" }, "created_by": { "zuid": "74660608", "is_confirmed": "False", "email_id": "emmy@zylker.com", "first_name": "Amelia Burrows", "last_name": "C", "user_type": "Admin", "user_id": "6759000000009004" }, "created_time": "Mar 26, 2024 12:44 PM", "modified_by": { "zuid": "74660608", "is_confirmed": "False", "email_id": "emmy@zylker.com", "first_name": "Amelia Burrows", "last_name": "C", "user_type": "Admin", "user_id": "6759000000009004" }, "modified_time": "Mar 30, 2024 11:38 AM", "bucket_meta": { "versioning": "False", "caching": { "status": "Enabled", "delivery_point_id": "01ht6zj7k536c29ymsgfeky1mg" }, "encryption": "False", "audit_consent": "False" }, "bucket_url": "https://zcstratus122-development.zohostratus.com", "caching_url": "https://zcstratus122-development.nimbuslocaledge.com", "objects_count": "74", "size_in_bytes": "925906411" } -------------------------------------------------------------------------------- title: "Bucket CORSの取得" description: "このページでは、BucketのCORS設定を取得するためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.333Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/get-bucket-cors/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Stratus Bucket CORS Help Documentation (/ja/cloud-scale/help/stratus/stratus-config/bucket-cors/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/get-bucket-cors/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/get-bucket-cors/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Bucket CORSの取得 getCors() SDKメソッドは、Stratus内の特定のBucketの現在のCORS設定を返します。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 BucketのCORSは、Profiles & Permissionsセクションを使用して、プロジェクト内のStratusコンポーネントに対するWrite権限を持つ、または付与されたすべてのユーザーが編集できます。 Note: Bucket CORSの詳細については、このヘルプセクションをご覧ください。 const cors = await bucket.getCors(); console.log(cors); -------------------------------------------------------------------------------- title: "Bucket内のObjectsの一覧取得" description: "このページでは、Bucket内に保存されたObjectsを一覧取得するためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.333Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/list-objects/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/list-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/list-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/get-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/get-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/get-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Bucket内のObjectsの一覧取得 ### ページネーションによるすべてのObjectsの一覧取得 このSDKメソッドを使用すると、ページネーションにより特定のBucket内に存在するすべてのオブジェクトの一覧を取得できます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 各呼び出しでは限られた数のオブジェクトが返され、次の呼び出しは継続トークンが返された場合にのみ開始されます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">Parameter Name</th> <th class="w20p">Data Type</th> <th class="w60p">Definition</th> </tr> </thead> <tbody> <tr> <td>maxKey</td> <td>String</td> <td>必須パラメータです。ページネーションで一覧取得できるオブジェクトの最大数を含みます。</td> </tr> <tr> <td>nextToken</td> <td>String</td> <td>必須パラメータです。次のオブジェクトセットを取得するためのトークンを含みます。</td> </tr> <tr> <td>prefix</td> <td>String</td> <td>任意パラメータです。プレフィックス値に一致するオブジェクトを一覧取得します。</td> </tr> <tr> <td>orderBy</td> <td>String</td> <td>任意パラメータです。オブジェクトを昇順または降順で一覧取得します。デフォルト値: asc</td> </tr> <tr> <td>folderListing</td> <td>String</td> <td>任意パラメータです。Bucket内のルートレベルのオブジェクトのみを一覧取得するか、Bucket内のすべてのパスに存在するすべてのオブジェクトを一覧取得するかを選択します。デフォルト値: false<br />たとえば、値をtrueに設定すると、ルートレベルのオブジェクトのみが一覧表示されます。値をfalseに設定すると、Bucket内のすべてのパスに存在するすべてのオブジェクトが一覧表示されます。 </td> </tr> </tbody> </table> 以下のSDKメソッドでは、maxKeyを使用してページネーションの最大値が設定されています。prefixを使用すると、prefixに一致するオブジェクトのみを一覧取得できます。 取得するレスポンスには、Bucketの以下のプロパティが含まれ、moreOptionsに格納されます： * key count: 返されるオブジェクトの数の値を含みます * max keys: 返すことができるオブジェクトの最大数 * Truncated: Bucketが切り捨てられているかどうかを通知するステータスを含みます * contents: オブジェクト詳細の一覧 * continuation_token: リクエストでcontinuation_tokenを送信した場合、レスポンスに表示されます * next_continuation_token: レスポンスが切り捨てられた場合、次のオブジェクトセットを取得するために、このキーの値を同じメソッドにcontinuation_tokenとして渡す必要があります 各反復で、maxKeyの数のオブジェクトを一覧取得し、nextTokenが作成されたかどうかを確認します。nextTokenを使用して、すべてのオブジェクトが一覧取得されるまで反復を継続します。 async function listMyPaginatedObjects(maxKeys = null, prefix = null, nextToken = null) { const options = { // 1回の呼び出しで返すキーの最大数 maxKeys, // 次のオブジェクトページを取得するためのトークン continuationToken: nextToken, // オブジェクトのリスト順序: 'asc'または'desc' // orderBy: 'desc', // フォルダ構造(true)またはフラット構造(false)でオブジェクトをリストするかどうか // folderListing: 'true', // このプレフィックスのオブジェクトのみリストする prefix }; // オブジェクトの1ページを取得する const objects = await bucket.listPagedObjects(options); console.log("response:", objects.contents); // さらにオブジェクトがある場合、再帰的に次のセットを取得する if (objects.truncated) { listMyPaginatedObjects(maxKeys, prefix, objects.next_continuation_token); } } // 1ページあたり最大2キー、プレフィックス「sam」でオブジェクトをリストする初回呼び出し await listMyPaginatedObjects(5, "sam"); #### レスポンス例 { "prefix": "sam", "key_count": "5", "max_keys": "5", "truncated": "True", "next_continuation_token": "47VrqTzR9ukMF9gr8YcziVVzdRP5GCjq1NfM5fMBpMfvw5qcXFRSueuqCTRUCzNd9dHfquXHi2afDanLH6MbyJo6", "contents": [ { "key_type": "file", "key": "sam1s2ww.mp4", "size": "427160684", "content_type": "video/mp4", "etag": "78c2b173b56cd944e9c79abd601f6073", "last_modified": "May 21, 2024 01:00 PM" }, { "key_type": "file", "key": "samdm.txt", "size": "23", "content_type": "text/plain; charset=utf-8", "etag": "c0122754f465e42eb97b5af174663c29", "last_modified": "May 14, 2024 01:30 PM" }, { "key_type": "file", "key": "samplvbse1.json", "size": "8", "content_type": "application/json", "etag": "499e7dbaee453352a9c17407a676dbda", "last_modified": "May 13, 2024 10:05 AM" }, { "key_type": "file", "key": "samplse1.json", "size": "8", "content_type": "application/json", "etag": "499e7dbaee453352a9c17407a676dbda", "last_modified": "May 13, 2024 09:20 AM" }, { "key_type": "file", "key": "sampjkhdldbed.mp4", "size": "0", "content_type": "video/mp4", "etag": "d41d8cd98f00b204e9800998ecf8427e", "last_modified": "May 12, 2024 10:54 PM" } ] } <br> ### イテレーションによるObjectsの一覧取得 このSDKメソッドを使用すると、イテレーション手法を使用して、1回のAPI呼び出しでBucket内に存在するすべてのオブジェクトを一覧取得できます。maxKey変数を使用して、必要な数のオブジェクトにアクセスできます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 const options = { // リクエストあたりの最大オブジェクト数 maxKeys: 5, // オブジェクトのリスト順序: 'asc'または'desc' // orderBy: 'desc', // フォルダ構造(true)またはフラット構造(false)でオブジェクトをリストするかどうか // folderListing: 'true', // 指定されたプレフィックスで始まるオブジェクトのみリストする prefix: 's' }; // バケットからイテラブルファイルをリストする const files = bucket.listIterableObjects(options); for await (const file of files) { console.log('file:', file); } #### レスポンス例 { "key_type": "file", "key": "ssdgs.mp4", "size": "3145728", "content_type": "video/mp4", "etag": "9685b8d5b8b719274bac854b897d95ec", "last_modified": "May 21, 2024 03:49 PM" } { "key_type": "file", "key": "Sasss.mp4", "size": "2674", "content_type": "video/mp4", "etag": "24c1122087e9be930ff1e957e83f5224", "last_modified": "May 21, 2024 02:55 PM" } { "key_type": "file", "key": "Samfplessss.mp4", "size": "2674", "content_type": "video/mp4", "etag": "24c1122087e9be930ff1e957e83f5224", "last_modified": "May 21, 2024 02:52 PM" } { "key_type": "file", "key": "demo.mp4", "size": "3400", "content_type": "video/mp4", "etag": "24e957e83f5224c1122087e9be930ff1", "last_modified": "May 21, 2024 02:52 PM" } { "key_type": "file", "key": "performance.mp4", "size": "1454", "content_type": "video/mp4", "etag": "087e9be930ff124c1122e957e83f5224", "last_modified": "May 21, 2024 02:52 PM" } -------------------------------------------------------------------------------- title: "Objectの存在確認" description: "このページでは、Bucket内にオブジェクトが存在するかどうかを確認するためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.333Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/check-object-availability/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/check-object-availability/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/check-object-availability/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Objectの存在確認 このSDKメソッドを使用すると、特定のオブジェクトがBucket内に存在するか、またユーザーがそのオブジェクトにアクセスするために必要な権限を持っているかを確認できます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 BucketでVersioningを有効にしている場合、特定のバージョンのオブジェクトが利用可能かどうかを確認するために、パラメータとしてversionIDを渡す必要があります。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 このSDKメソッドを使用すると、以下のいずれかのレスポンスが返されます： - **true**: オブジェクトが利用可能で、指定されたバージョンが利用可能で、ユーザーがオブジェクトにアクセスするための適切な権限を持っている場合。 - **false**: - オブジェクトまたはオブジェクトの特定のバージョンがBucket内に利用できない場合。 - ユーザーがオブジェクトにアクセスするために必要な権限を持っていない場合。 - Bucketが存在しない場合。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">Parameter Name</th> <th class="w20p">Data Type</th> <th class="w60p">Definition</th> </tr> </thead> <tbody> <tr> <td>objectName</td> <td>String</td> <td>必須パラメータです。オブジェクトの完全な名前を保持します。</td> </tr> <tr> <td>versionId</td> <td>String</td> <td>任意パラメータです。Versioningが有効な場合、オブジェクトの一意のバージョンIDを保持します。</td> </tr> <tr> <td>throwErr</td> <td>Boolean</td> <td>任意パラメータです。このパラメータを「true」に設定すると、プロジェクト内にBucketが見つからない場合にエラーをスローします。デフォルト値は「false」です。</td> </tr> </tbody> </table> const options = { versionId: 'djkfhdiufy762', throwErr: false }; const headObjectRes = await bucket.headObject("sam/out/sample.txt", options); console.log(headObjectRes); **発生する可能性のあるエラー** Note: throwErrパラメータを指定してSDKを使用し、オブジェクトが存在しない場合、または十分な権限がない場合、以下に記載されたエラーのいずれかが発生する可能性があります。 <table class="content-table"> <thead> <tr> <th class="w30p">Error Code</th> <th class="w70p">Meaning</th> </tr> </thead> <tbody> <tr> <td>404</td> <td>Not Found。Objectが見つかりません。</td> </tr> <tr> <td>401</td> <td>Unauthorized/Access Denied - ユーザーに特定の操作を実行する権限がありません。</td> </tr> <tr> <td>403</td> <td>Permission Denied - ユーザーに特定のオブジェクトにアクセスする権限がありません。</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "Objectのダウンロード" description: "このページでは、BucketからオブジェクトをダウンロードするためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.333Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/download-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Download Object Help Documentation (/ja/cloud-scale/help/stratus/objects/manage-object/download-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/download-object/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/download-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/download-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/download-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/download-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Objectのダウンロード ### Objectのダウンロード このセクションのSDKを使用すると、特定のオブジェクト、複数のオブジェクト、またはオブジェクトのバージョンをダウンロードできます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 ダウンロード操作の最初のステップは、Bucketから必要なオブジェクトを取得するGET操作です。 オブジェクトをダウンロードするには、リクエスターにREADアクセス権限が必要です。ただし、Bucketの所有者は、必要なレスポンスヘッダーを使用せずにオブジェクトをダウンロードできるように、ユーザーにREADアクセス権限を付与するオプションがあります。 BucketでVersioningが有効な場合、特定のバージョンのオブジェクトをダウンロードするにはversionIdを渡す必要があります。versionIdを渡さない場合、デフォルトで最新バージョンのオブジェクトがダウンロードされます。 Bucketで*Versioning*が有効にされた後、無効にされた場合。デフォルトでは、プリンシパルの最初のオブジェクトがダウンロードされます。このオブジェクトの最新バージョンをダウンロードするには、versionIdパラメータに値「topVersion」を渡す必要があります。 const res = await bucket.getObject("sam/out/sample.txt"); // オブジェクトをローカルマシンにダウンロードする const files = fs.createWriteStream('filePath'); res.on('data', (data) => { files.write(data) }); ### Objectの一部をダウンロード 以下のSDKメソッドは、rangeパラメータとともに使用されます。rangeパラメータを使用すると、オブジェクトの特定のrangeのバイトをダウンロードできます。 const options = { 'versionId': 'djkshr8374yiuhf48', // 指定されたversionIdでオブジェクトをダウンロード 'range': '0-2000' // オブジェクトの開始・終了範囲（バイト単位） } const res = await bucket.getObject("sam/out/sample.txt", options); // オブジェクトをローカルマシンにダウンロードする const files = fs.createWriteStream('filePath'); res.on('data', (data) => { files.write(data) }); ### Transfer Managerを使用したObjectのダウンロード このセクションでは、**Transfer Manager**技術を使用して、Stratusからローカルシステムに大きなオブジェクトを正常にダウンロードするためのSDKメソッドについて説明します。Transfer Managerは、大きなオブジェクトをオブジェクトの開始バイトと終了バイトの範囲を使用して複数のバイト範囲に分割する操作です。オブジェクトの各パートはストリームとして返され、ローカルシステムにダウンロードされます。 **以下のパッケージがインポートされていることを確認してください** const { TransferManager } = require('zcatalyst-sdk-node/lib/stratus'); #### Transfer Managerインスタンスの作成 const transferManager = new TransferManager(bucket); // Transfer Managerインスタンスを作成 #### イテラブルパートストリームとしてのObjectダウンロード const partSize=50; const getObjectRes = await transferManager.getIterableObject("sam/out/sample.txt",partSize); // オブジェクトをローカルマシンにダウンロードする const file = fs.createWriteStream('filePath'); // ファイル書き込みストリームを作成 for await (const chunk of getObjectRes) { file.write(chunk); } #### ダウンロード用のObjectパーツの生成 このSDKメソッドでは、必要な開始バイトと終了バイトの範囲に該当するオブジェクトの一部をダウンロードします。 const file = fs.createWriteStream("filePath"); const partSize = 50; const downloadRes = await transferManager.generatePartDownloaders("sam/out/sample.txt", partSize); let partNum = 0; while (partNum < downloadRes.length) { const objectPart = downloadRes[partNum++]; const buffer = await objectPart(); // オブジェクトの一部をストリームとして返す // ストリームを処理する } ### Objectダウンロード用の署名付きURLの生成 署名付きURLは、認証済みユーザーが非認証ユーザーに共有できる安全なURLです。このURLは、非認証ユーザーにオブジェクトにアクセスするための一時的な認可を提供します。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">Parameter Name</th> <th class="w20p">Data Type</th> <th class="w60p">Definition</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトの完全な名前とパスを保持します。</td> </tr> <tr> <td>urlAction</td> <td>Request Method</td> <td>必須パラメータです。ダウンロード(GET)アクション用の署名付きURLを生成するためのパラメータです。 <ul> <li>**GET**: オブジェクトをダウンロードするため</li> </ul> </td> </tr> <tr> <td>expiry</td> <td>String</td> <td>任意パラメータです。URLの有効時間（秒単位）。 <ul> <li>デフォルト値: 3600秒</li> <li>最小値: 30秒</li> <li>最大値: 7日</li> </ul> </td> </tr> <tr> <td>activeFrom</td> <td>String</td> <td>任意パラメータです。URLが有効になる時間を含みます。最大値は7日です。デフォルトでは、URLは生成されるとすぐに有効になります。</td> </tr> </tbody> </table> const signedURLRes = await bucket.generatePreSignedUrl("sam/out/sample.txt", 'GET', { 'expiryIn': 100, // 有効期限（秒） 'activeFrom':'12334454327', // 指定された日付にURLを有効化 'versionId': '746398diij94839' }); console.log(signedURLRes); **ダウンロード用署名付きURLの生成レスポンス例** { "signature": "https://sadi-development.zohostratus.com/_signed/text.txt?organizationId=96862383&stsCredential=96858154-96862383&stsDate=1747898364894&stsExpiresAfter=300&stsSignedHeaders=host&stsSignature=SFdW4woI5nXPCSCghrymsv06hM0cimwZpkFwHWngtto", "expiry_in_seconds": "100", "active_from": "12334454327" } **署名付きURLを使用したObjectダウンロードのスニペット例** Info: この例は、Axiosリクエストハンドラーパッケージを使用して示されています。 const axios = require('axios'); const fs = require('fs'); // ファイルの実際の署名付きURLに置き換えてください。 const url = 'https://sadi-development.zohostratus.com/_signed/text.txt?organizationId=96862383&stsCredential=96858154-96862383&stsDate=1747898364894&stsExpiresAfter=300&stsSignedHeaders=host&stsSignature=SFdW4woI5nXPCSCghrymsv06hM0cimwZpkFwHWngtto'; (async () => { try { // ファイルをストリームとしてダウンロードするGETリクエストを送信する const response = await axios.get(url, { responseType: 'stream' }); // ファイルをローカルに保存するための書き込みストリームを作成する const file = fs.createWriteStream('file_path'); // 希望の出力パスに置き換えてください // レスポンスストリームをファイルストリームにパイプする response.data.pipe(file); // ファイルのダウンロード完了時に通知する file.on('finish', () => { console.log('File downloaded successfully'); }); // 書き込み中のエラーを処理する file.on('error', (err) => { console.error('Error writing file:', err); }); } catch (err) { console.error('Error downloading file:', err); } })(); -------------------------------------------------------------------------------- title: "Objectのアップロード" description: "このページでは、BucketにオブジェクトをアップロードするためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.334Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/upload-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Upload Object Help Documentation (/ja/cloud-scale/help/stratus/objects/upload-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/upload-object/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/upload-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/upload-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/upload-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/upload-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/upload-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Objectのアップロード このセクションに記載されているSDKメソッドを使用すると、さまざまな方法でBucketにオブジェクトをアップロードできます。オブジェクトを**文字列**または**ストリーム**としてアップロードできます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 オブジェクトに対してVersioningを有効にしていない場合、Stratusが同じオブジェクトに対して複数の書き込みリクエストを受信すると、オブジェクトは継続的に上書きされます。最新のアップロードのオブジェクトのみが保存されます。 ただし、Versioningが有効な場合、各アップロードはオブジェクトのバージョンとみなされ、それぞれ一意のversionIdでBucket内に保存されます。 Note: パスまたはオブジェクトを作成する際、スペースを含む以下の文字はサポートされていません：ダブルクォーテーション、両方の山括弧、ハッシュタグ、バックスラッシュ、パイプ記号。 ### ストリームとしてのObjectのアップロード このSDKメソッドを使用すると、ストリームとしてオブジェクトをBucketにアップロードできます。ストリームを変数に格納し、その変数をアップロードメソッドputObject()に渡します。 // オブジェクトアップロード用のリードストリームを作成する const file = fs.createReadStream("file_path"); // アップロードメソッドを呼び出す const res = await bucket.putObject("sam/out/sample.txt", file); console.log(res); ### 文字列としてのObjectのアップロード このSDKメソッドを使用すると、オブジェクトを文字列としてアップロードできます。オブジェクト名と、文字列形式でオブジェクトに保存するデータをアップロードメソッドputObject()に渡します。 //オブジェクトを文字列としてアップロードする const res = await bucket.putObject("sam/out/sample.txt", "Content of the file"); console.log(res); ### オプション付きObjectのアップロード このSDKメソッドを使用すると、オブジェクトのアップロード時に以下のオプションを使用できます。 * **overwrite**: Bucketで*Versioning*が有効になっていない場合に使用できるオプションです。バージョニングなしでは、リソースを上書きする場合にこのオプションを使用する必要があります。デフォルト値は「**false**」です。 * **ttl**: オブジェクトの**Time-to-Live**（TTL）を秒単位で設定するために使用できるオプションです。値は**60秒**以上である必要があります。 * **metaData**: アップロードされるオブジェクトのメタ情報をアップロードするために使用できるオプションです。 * **contentType**: オブジェクトのMIMEタイプを設定する必要がある場合に指定できるオプションです。 const options = { 'overwrite': true, //これにより既存のオブジェクトが上書きされます 'ttl': '300', //有効期限（秒単位） 'metaData': { 'author': 'John' } }; const file = fs.createReadStream("filePath"); const uploadRes = await bucket.putObject("sam/out/sample.txt", file, options); console.log(uploadRes); ### 解凍オプション付きObjectのアップロード このSDKメソッドを使用してZIPオブジェクトをアップロードすると、ZIP内のオブジェクトが解凍され、アップロードされます。 const options = { 'ttl': '300', //有効期限（秒単位） 'metaData': { 'author': 'John' }, // 指定されたZIPファイルの内容を展開し、各ファイルを個別のオブジェクトとしてバケットにアップロードする 'extractUpload': true }; const file = fs.createReadStream("filePath"); const uploadRes = await bucket.putObject("sam/out/sample.zip", file, options); console.log(uploadRes); このSDKメソッドはtaskIdの値を返します。この値を使用して、このSDKメソッドで解凍のステータスを確認できます。 **レスポンス例** { 'task_id': '1234263749' } ### マルチパートを使用したObjectのアップロード このセクションでは、Stratus内のBucketに大きなオブジェクトを正常にアップロードするためのSDKメソッドについて説明します。 マルチパートアップロード機能は、複数のHTTPSリクエストで大きなファイルをBucketにアップロードします。すべての個別パートがアップロードされると、これらすべてのリクエストが単一のオブジェクトに結合されます。 Note: **100 MB以上**のオブジェクトをアップロードする場合は、マルチパートアップロードを推奨方法として検討してください。 #### アップロードの開始 マルチパート操作を実行するには、マルチパートオブジェクトインスタンスを取得する必要があります。このコンポーネントインスタンスは、Stratus内のBucketに保存されたオブジェクトに対するマルチパート操作を行うさまざまなコードスニペットで参照されます。 **使用パラメータ** bucket: このSDKメソッドを使用して事前に初期化しておく必要があるBucketインスタンスです。 const initRes = await bucket.initiateMultipartUpload("sam/out/sample.txt"); console.log(initRes); **レスポンス例** { "bucket": "zcstratus123-development", "key": "sam/out/sample.txt", "upload_id": "01j7xbm4vm5750zbedxqgc4q6m", "status": "PENDING" } #### Objectのパーツのアップロード 以下のSDKメソッドでは、オブジェクトの個別パーツのアップロードを実行します。各パーツには1〜1000の間の異なるpartNumberがあります。これはパーツの順序を表しますが、これらのパーツは必ずしも順番にアップロードされるわけではありません。すべてのパーツのアップロードが完了すると、これらのパーツは順番に結合されます。 let partNumber = 1; const file = fs.createReadStream("filePath"); const uploadPartRes = await bucket.uploadPart("sam/out/sample.txt", "uploadId", file, partNumber); console.log(uploadPartRes); #### マルチパートアップロードのサマリーの取得 以下のSDKメソッドを使用して、アップロードされたすべてのパーツの操作サマリーを取得できます。サマリーを表示するには、getMultipartUploadSummary()メソッドを使用します。 const uploadSummaryRes = await bucket.getMultipartUploadSummary("sam/out/sample.txt", "upload_id"); console.log(uploadSummaryRes); **レスポンス例** { "bucket": "zcstratus12345-development", "key": "sam/out/sample.txt", "upload_id": "01hyfyeazrrstmt7k5fa7ej726", "status": "PENDING", "parts": [ { "part_number": 1, "size": 0, "uploaded_at": 1716374678999 }, { "part_number": 2, "size": 2797094, "uploaded_at": 1716374678576 }, { "part_number": 4, "size": 0, "uploaded_at": 1716374679136 } ] } #### Objectのマルチパートアップロードの完了 以下のメソッドを使用すると、すべてのパーツが正常にアップロードされた後にマルチパートプロセスを終了できます。プロセスを完了するには、completeMultipartUpload()メソッドにuploadIdを渡します。 const completeUploadRes = await bucket.completeMultipartUpload("sam/out/sample.txt", "uploadId"); console.log(completeUploadRes); **SDK実装例** const catalyst = require('zcatalyst-sdk-node'); const fs = require('fs'); module.exports = async (req, res) => { url = req.url; switch (url) { case '/': const app = catalyst.initialize(req); const stratus = app.stratus(); // バケットインスタンスを作成する const bucket = stratus.bucket("bucket_name"); // マルチパートアップロード const key = 'sample.mp4'; // マルチパートアップロードを開始する const initRes = await bucket.initiateMultipartUpload(key); // アップロード開始レスポンスからアップロードIDを取得する。 const uploadId = initRes['upload_id']; const filePath = '/Users/Aliza//sam.mp4'; const partSize = 50 * 1024 * 1024; // MB単位 const fileStream = fs.createReadStream( filePath, { highWaterMark: partSize } ); let partNumber = 1; const uploadPromises = []; fileStream.on('data', async (partData) => { // 各パートのアップロードをPromise配列に追加して並列アップロードする const partUploadPromise = bucket.uploadPart( key, uploadId, partData, partNumber ); uploadPromises.push(partUploadPromise); console.log('Part Number: ', partNumber); partNumber++; }); // すべてのパートが並列でアップロードされるのを待つ fileStream.on('end', async () => { await Promise.all(uploadPromises); // マルチパートアップロードを完了する await bucket.completeMultipartUpload(key, uploadId); console.log('Successfully Uploaded'); }); res.end(); break; default: res.writeHead(404); res.write('You might find the page you are looking for at "/" path'); break; } } ### Transfer Managerを使用したObjectのアップロード **以下のパッケージがインポートされていることを確認してください** const { TransferManager } = require('zcatalyst-sdk-node/lib/stratus'); #### Transfer Managerインスタンスの作成 const transferManager = new TransferManager(bucket); // Transfer Managerインスタンスを作成 #### マルチパートアップロード **マルチパートアップロードインスタンスの作成** 以下のSDKメソッドは、マルチパートアップロードを開始してマルチパートインスタンスを作成します。 const multipart = await transferManager.createMultipartInstance("sam/out/sample.txt"); // マルチパートインスタンスを作成 既に初期化されたマルチパートアップロード操作のインスタンスを作成する必要がある場合は、以下のコードスニペットをコピーして使用してください。 const multipart = await transferManager.createMultipartInstance("sam/out/sample.txt", "uploadId"); #### パーツのアップロード 以下のSDKメソッドでは、*マルチパートアップロードインスタンスの作成*セクションで初期化したmultipartインスタンスを使用します。 const uploadRes = await multipart.uploadPart(fs.createReadStream("filePath"), partNumber); console.log(uploadRes); #### アップロードサマリー const summaryRes = await multipart.getUploadSummary(); console.log(summaryRes); #### アップロードの完了 const completeRes = await multipart.completeUpload(); console.log(completeRes); #### ラッパーを使用したObjectのアップロード 以下のSDKメソッドはラッパーとして機能し、複数のステップを使用せずにマルチパートアップロード操作全体が実行されます。この方法を使用すると、オブジェクトは複数のパーツに分割され、複数のパーツとしてBucketにアップロードされ、すべてのパーツがアップロードされると結合されます。 const file = fs.createReadStream("filePath"); const partSize = 50 // MB単位 const objectPartUploadRes = await transferManager.putObjectAsParts("sam/out/sample.txt",file, partSize); console.log(objectPartUploadRes); ### Objectアップロード用の署名付きURLの生成 署名付きURLは、認証済みユーザーが非認証ユーザーに共有できる安全なURLです。このURLは、非認証ユーザーにオブジェクトにアクセスするための一時的な認可を提供します。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">Parameter Name</th> <th class="w20p">Data Type</th> <th class="w60p">Definition</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトの完全な名前とパスを保持します。</td> </tr> <tr> <td>urlAction</td> <td>Request Method</td> <td>必須パラメータです。アップロード(PUT)アクション用の署名付きURLを生成するためのパラメータです。 <ul> <li>**PUT**: オブジェクトをアップロードするため</li> </ul> </td> </tr> <tr> <td>expiry</td> <td>String</td> <td>任意パラメータです。URLの有効時間（秒単位）。 <ul> <li>デフォルト値: 3600秒</li> <li>最小値: 30秒</li> <li>最大値: 7日</li> </ul> </td> </tr> <tr> <td>activeFrom</td> <td>String</td> <td>任意パラメータです。URLが有効になる時間を含みます。最大値は7日です。デフォルトでは、URLは生成されるとすぐに有効になります。</td> </tr> </tbody> </table> const signedURLRes = await bucket.generatePreSignedUrl("sam/out/sample.txt", 'PUT', { 'expiryIn': 100, // 有効期限（秒） 'activeFrom':'12334454327', // 指定された日付にURLを有効化 }); console.log(signedURLRes); **アップロード用署名付きURLの生成レスポンス例** { signature: "https://sadi-development.zohostratus.com/_signed/text.txt?organizationId=96862383&stsCredential=96858154-96862383&stsDate=1747896279887&stsExpiresAfter=300&stsSignedHeaders=host&stsSignature=3YBUX1HFSxNQzQJjFrln82AyJsEEuC5T9dsZwWxGyEE" } **署名付きURLを使用したObjectアップロードのスニペット例** Info: この例は、Axiosリクエストハンドラーパッケージを使用して示されています。 const axios = require('axios'); const fs = require('fs'); // アップロード用に生成された実際の署名付きURLに置き換えてください。 const url = 'https://sadi-development.zohostratus.com/_signed/text.txt?organizationId=96862383&stsCredential=96858154-96862383&stsDate=1747911331272&stsExpiresAfter=300&stsSignedHeaders=host&stsSignature=K9vuqC7JaATLeM3TX4xXWx0OHcSflbYQ2jCrbKSAAIE'; // 'file_path'を実際のファイルパスに置き換えてください const data = fs.createReadStream('/Users/ranjitha-18338/Documents/NODE-SDK/Stratus/sam.py'); // オプションのヘッダー。コンテンツタイプはファイルタイプによって異なる場合があります const headers = { // 'Content-Type': 'application/json', // 非JSONファイルをアップロードする場合は調整してください（例：'text/plain'または'application/octet-stream'） // 'overwrite': 'true', // オプションのヘッダー }; (async () => { try { const response = await axios.put(url, data, { headers }); if (response.status === 200) { console.log('Object uploaded successfully'); } else { console.log('⚠️ Error uploading object:', response.data); } } catch (error) { console.error('Upload failed:', error.response?.data || error.message); } })(); -------------------------------------------------------------------------------- title: "ZIPオブジェクトの解凍" description: "このページでは、ZIPオブジェクトを解凍するためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.334Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/extract-zipped-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/extract-zipped-object/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/extract-zipped-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Stratus内のZIPオブジェクトの解凍 以下のSDKメソッドを使用すると、Stratus内でZIPファイルを解凍し、ZIPファイル内の個々のコンテンツはそれぞれ個別のオブジェクトとして同じBucket内のStratusにアップロードされます。このプロセス全体は*非同期的*に行われます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 Note: 解凍プロセスは非同期的に行われるため、プロセス全体が完了するまでの時間は、解凍されるZIPファイルのサイズに依存します。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">Parameter Name</th> <th class="w20p">Data Type</th> <th class="w60p">Definition</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。解凍するZIPファイルの名前です。</td> </tr> <tr> <td>destPath</td> <td>String</td> <td>必須パラメータです。解凍されたオブジェクトがBucket内に保存される宛先の完全なパス情報を含みます。</td> </tr> </tbody> </table> const res = await bucket.unzipObject("sample.zip","output/"); console.log(res); #### レスポンス例 { "key": "sample.zip", "destination": "output/", "task_id": "6963000000272049", "message": "Zip extract scheduled" } ### ZIP解凍ステータスの取得 ZIP解凍プロセスは非同期的に行われ、解凍プロセスが完了するまでの時間はZIPファイルのサイズに大きく依存します。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 以下のSDKメソッドでtaskIdパラメータを使用して、解凍のステータスを確認できます。taskIdはunzipObject()メソッドのレスポンスで返されます。 const statusRes = await bucket.getUnzipStatus("sample.zip", 'taskId'); console.log(statusRes); #### レスポンス例 { "task_id": "6963000000272049", "status": "SUCCESS" } -------------------------------------------------------------------------------- title: "Objectのコピー" description: "このページでは、Bucket内でオブジェクトのコピーを作成するためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.335Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/copy-objects/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/copy-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/copy-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Objectのコピー このSDKメソッドを使用すると、Bucket内でオブジェクトをコピーして貼り付けることができます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 keyはコピーするオブジェクトであり、destinationはコピーされたオブジェクトの新しい名前を含みます。コピーしたオブジェクトを別のパスに貼り付けるには、destinationとして完全なパス名を指定する必要があります。 Note: * keyとdestinationの両方の値には、パスとともに完全なオブジェクト名を指定する必要があります。 * たとえば、パスpictures/puppyに「kitten.png」というファイルがあり、そのファイルをpictures/kittenパスにコピーする必要がある場合：<br /> source_objectの値は「pictures/puppy/kitten.png」になります<br /> dest_objectの値は「pictures/kitten/kitten.png」になります<br /> const res = await bucket.copyObject('sam/out/sample.txt', "out/sam/sample.txt"); console.log(res); #### レスポンス例 { "copy_to": "sam/out/sample.txt", "key": "out/sam/sample.txt", "message": "Object copied successfully." } -------------------------------------------------------------------------------- title: "Objectの名前変更と移動操作" description: "このページでは、オブジェクトの名前変更と移動操作を実行するためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.335Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/rename-move-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/rename-move-object/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/rename-move-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Objectの名前変更と移動操作 オブジェクトの名前変更と移動には、同じrenameObject() SDKメソッドを使用します。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">Parameter Name</th> <th class="w20p">Data Type</th> <th class="w60p">Definition</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>名前を変更する必要があるオブジェクトの元の名前</td> </tr> <tr> <td>destination</td> <td>String</td> <td>オブジェクトの新しい名前</td> </tr> </tbody> </table> Note: * keyとdestinationの両方の値には、パスとともに完全なオブジェクト名を指定する必要があります。 * たとえば、パスpictures/puppyに「kitten.png」というファイルがあり、そのファイルをpictures/kittenパスに名前変更または移動する必要がある場合：<br /> keyの値は「pictures/puppy/kitten.png」になります<br /> destinationの値は「pictures/kitten/kitten.png」になります<br /> ### Objectの名前変更 renameObject() SDKメソッドを使用して、Bucket内のオブジェクトの名前を変更できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 Note: * Versioningが有効なBucket内のオブジェクトの名前を変更することはできません。 * パスまたはオブジェクトを作成する際、スペースを含む以下の文字はサポートされていません：ダブルクォーテーション、両方の山括弧、ハッシュタグ、バックスラッシュ、パイプ記号。 const res = await bucket.renameObject("sam/out/sample.txt", "sam/out/update_sample.txt"); console.log(res); ### Objectの移動 renameObject() SDKメソッドを使用して、Bucket内のあるパスから別のパスにオブジェクトを移動できます。 const moveRes = await bucket.renameObject("sam/out/sample.txt", "out/sample.txt"); console.log(moveRes); Note: Versioningが有効なBucketでは移動操作を実行できません。 #### 名前変更と移動操作のレスポンス例 { "current_key": "sam/out/sample.txt", "message": "Rename successful", "rename_to": "sam/out/update_sample.txt" } -------------------------------------------------------------------------------- title: "Objectsの削除" description: "このページでは、Bucket内に保存されたオブジェクトを削除するためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.335Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/delete-objects/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Delete an Object Help Documentation (/ja/cloud-scale/help/stratus/objects/manage-object/delete-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/delete-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/delete-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/delete-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/delete-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/delete-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/delete-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Objectsの削除 以下のSDKメソッドを使用すると、Stratusで削除操作を実行できます。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">Parameter Name</th> <th class="w20p">Data Type</th> <th class="w60p">Definition</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトの完全な名前とパスを保持します。</td> </tr> <tr> <td>versionId</td> <td>String</td> <td>任意パラメータです。BucketでVersioningが有効な場合、このパラメータを使用して一意のバージョンIDで特定のバージョンを参照できます。</td> </tr> <tr> <td>ttl</td> <td>int</td> <td>任意パラメータです。削除操作をスケジュールできます。たとえば、ttlの値を60と指定すると、削除操作は60秒後にのみ実行されます。ttlの値は60秒以上である必要があります。</td> </tr> </tbody> </table> ### 単一Objectの削除 このSDKメソッドを使用すると、deleteObject()メソッドにオブジェクト名を渡すことで特定のオブジェクトを削除できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 const res = await bucket.deleteObject( "sam/out/sample.txt"); console.log(res); Note: BucketでVersioningが有効で、特定のversionIdが指定されていない場合、オブジェクトを削除するとデフォルトでそのオブジェクトのすべてのバージョンが削除されます。 ### 特定の時間後にObjectの特定バージョンを削除 BucketでVersioningを有効にしている場合は、オブジェクトのversionIdを必ず指定してください。ttl変数を使用して削除操作をスケジュールすることもできます。たとえば、ttlの値を**100**と指定すると、削除操作は**100秒**後にのみ実行されます。ttlの値は常に**60秒**以上であることを確認してください。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 const options = { versionId: "01hthq82gwxtfyz6d9j8eg6k2f", // 指定されたversionIdでオブジェクトを削除 ttl: 100 // 有効期間（秒数） }; const res= await bucket.deleteObject( "sam/out/sample.txt", options); console.log(res); ### 複数Objectsの削除 このSDKメソッドを使用すると、削除する必要があるオブジェクトの名前を配列として渡すことで、複数のオブジェクトを削除できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 BucketでVersioningを有効にしている場合は、オブジェクトのversionIdを必ず指定してください。ttl変数を使用して削除操作をスケジュールすることもできます。たとえば、ttlの値を**100**と指定すると、削除操作は**100秒**後にのみ実行されます。ttlの値は常に**60秒**以上であることを確認してください。 const objectDel = await bucket.deleteObjects( [ { key: "sam/out/sample.txt", versionId: "01hhch20nfkx9hw9ebqy2jnz9d" } ], 100); console.log(objectDel); #### 削除操作のレスポンス例 {"message": "Object Deletion successful."} ### Bucketの切り捨て このSDKメソッドを使用すると、Bucket内に存在するすべてのオブジェクトを削除できます。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 const truncateRes = await bucket.truncate(); console.log(truncateRes); ### Bucket内のパスの削除 このSDKを使用すると、パス内に存在するすべてのオブジェクトを削除できます。deletePath()メソッドに完全なパスを渡す必要があります。 Info: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションをご覧ください。 // パス全体を削除 const res = await bucket.deletePath("sam/out/"); console.log(res); Note: 正確なパスを指定してください。不正確なパスが指定された場合、削除アクションはスケジュールされますが、エラーが発生します。 #### レスポンス例 { "path": "sam/", "message": "Path deletion scheduled" } -------------------------------------------------------------------------------- title: "Objectインスタンスの作成" description: "このページでは、Objectインスタンスを作成するためのNode.js SDKメソッドを紹介します。" last_updated: "2026-06-10T06:04:54.335Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/create-object-instance/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/create-object-instance/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/create-object-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Objectインスタンスの作成 オブジェクト関連の操作を実行するためのオブジェクトインスタンスを取得するには、以下のメソッドを使用します。以下のコードスニペットで使用されているBucket参照は、コンポーネントインスタンスです。 const objectIns = bucket.object("sam/out/sample.txt"); -------------------------------------------------------------------------------- title: "オブジェクトバージョンの一覧取得" description: "このページでは、オブジェクトのバージョンを取得するためのNode.js SDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.335Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/list-object-versions/" service: "Cloud Scale" related: - Stratus コンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - オブジェクトバージョニングヘルプドキュメント (/ja/cloud-scale/help/stratus/stratus-config/general-settings/#versioning) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/get-object-versions/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/get-object-versions/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトバージョンの一覧取得 ### ページネーションによるオブジェクトの全バージョン一覧取得 バケットでバージョニングを有効にすると、同じオブジェクトの複数のバージョンをバケットに保存できます。オブジェクトの各バージョンには固有のversionIdが割り当てられます。このSDKメソッドを使用すると、バケット内のオブジェクトに存在するすべてのバージョンをページネーションで取得できます。以下のコードスニペットで使用されているObjectの参照は、コンポーネントインスタンスです。 情報: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご参照ください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">説明</th> </tr> </thead> <tbody> <tr> <td>nextToken</td> <td>String</td> <td>次のバージョンセットを取得するための値を保持します。</td> </tr> <tr> <td>maxVersions</td> <td>int</td> <td>任意のパラメータです。1回のイテレーションで一覧表示できるオブジェクトの最大バージョン数の値を保持します。</td> </tr> </tbody> </table> async function listMyPaginatedVersions(maxVersion = undefined, nextToken = undefined) { const response = await objectIns.listPagedVersions({ maxVersion, nextToken}); console.log(response.version); if(response.is_truncated) { listMyPaginatedVersions(maxVersion,nextToken) } } await listMyPaginatedVersions(10); **レスポンス例** { "key": "sam/out/sample.txt", "versions_count": 2, "max_versions": "2", "is_truncated": "False", "next_continuation_token": "4YpUdkktt2UeWp6MwEK1LZXELnuVhunHLnGgX29uvszwtJEQE2gVDJYyRiLdUmhNst", "version": [ { "version_id": "01hyfh12njtpyvzwq6p1fd2d8s", "is_latest": "True", "last_modified": "May 22, 2024 12:20 PM", "size": 1, "etag": "9af7c117d9de9a06fba7a5f1ea5fcc2d" }, { "version_id": "01hyfh0xkvwkxxsjfceef201xa", "is_latest": "False", "last_modified": "May 22, 2024 12:20 PM", "size": "1", "etag": "9af7c117d9de9a06fba7a5f1ea5fcc2d" } ] } ### イテレーションによるオブジェクトの全バージョン一覧取得 以下のSDKメソッドを使用すると、オブジェクトの利用可能なすべてのバージョンを1回の呼び出しで取得できます。 情報: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご参照ください。 const versions = objectIns.listIterableVersions(); for await( const version of versions) { console.log(version); } **レスポンス例** { "versionId": "01hyfh12njtpyvzwq6p1fd2d8s", "is_latest": "True", "last_modified": "May 22,2024 12:20 PM", "size": "1", "etag": "9af7c117d9de9a06fba7a5f1ea5fcc2d" } { "versionId": "01hyfh0xkvwkxxsjfceef201xa", "is_latest": "False", "last_modified": "May 22, 2024 12:20 PM", "size": "1", "etag": "9af7c117d9de9a06fba7a5f1ea5fcc2d" } -------------------------------------------------------------------------------- title: "オブジェクト詳細の取得" description: "このページでは、バケットに保存されているオブジェクトの詳細を取得するためのNode.js SDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.335Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/object-details/" service: "Cloud Scale" related: - Stratus コンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - オブジェクトヘルプドキュメント (/ja/cloud-scale/help/stratus/objects/introduction/) - バージョニングヘルプドキュメント (/ja/cloud-scale/help/stratus/stratus-config/general-settings/#versioning) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/object-details/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/check-object-availability/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクト詳細の取得 ### すべてのオブジェクトの詳細を取得する 以下のSDKメソッドを使用して、バケットに保存されているすべてのオブジェクトの詳細を取得します。以下のコードスニペットで使用されているObjectの参照は、コンポーネントインスタンスです。 情報: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご参照ください。 const objectRes = await objectIns.getDetails(); console.log(objectRes); 注意: バージョニングが有効な場合、このSDKメソッドを使用すると最新バージョンのオブジェクト詳細のみが返されます。 ### オブジェクトの特定バージョンの詳細を取得する オブジェクトの特定バージョンの詳細を取得するには、オブジェクトのversionIdをgetDetails() SDKメソッドに渡す必要があります。 情報: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご参照ください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">説明</th> </tr> </thead> <tbody> <tr> <td>versionId</td> <td>String</td> <td>任意のパラメータです。バケットでバージョニングが有効な場合、このパラメータを使用して固有のVersion IDで特定のバージョンを参照できます。</td> </tr> </tbody> </table> 注意: * このメソッドを使用するには、オブジェクトのバージョニングを少なくとも1回有効にしている必要があります。 * バージョニングの詳細については、こちらのヘルプドキュメントをご参照ください。 const objectRes = await objectIns.getDetails("versionId"); console.log(objectRes); **レスポンス例** { "key": "sam/out/sample.txt", "size": 1, "content_type": "text/plain", "last_modified": "May 22, 2024 12:25 PM", "meta_data": { "author": "John" }, "object_url": "https://zcstratus12345-development.zohostratus.com/sam/out/sample.txt", "cached_object_url": "https://zcstratus12345-development.nimbuslocaledge.com/sam/out/sample.txt" } -------------------------------------------------------------------------------- title: "オブジェクトメタデータの設定" description: "このページでは、オブジェクトに保存されているオブジェクトのメタデータを追加するためのNode.js SDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.336Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/stratus/put-object-meta/" service: "Cloud Scale" related: - Stratus コンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - オブジェクトメタデータヘルプドキュメント (/ja/cloud-scale/help/stratus/objects/introduction/#metadata) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/put-object-meta/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/put-object-meta/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトメタデータの設定 以下のSDKメソッドを使用して、Stratusのバケットに保存されている特定のオブジェクトにメタ情報を追加できます。以下のコードスニペットで使用されているObjectの参照は、コンポーネントインスタンスです。 情報: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご参照ください。 メタ情報はJSONのキーバリューペアとして渡します。例: {"meta_key" : "meta_value"} 注意: * 以下のメソッドを使用して、既存の情報を含めずに新しいメタ情報を渡すと、既存の情報が削除され、新しい情報のみが設定されます。これを避けるには、新しいメタ情報と既存のメタ情報を一緒に渡してください。 * メタデータの記述には、英数字、アンダースコア、空白文字、およびハイフンを使用できます。上記以外の特殊文字は使用できません。 * オブジェクトのメタデータは**HEAD**リクエストメソッドを使用して取得できます。レスポンスでは、メタデータはキー「x-user-meta」に一覧表示されます。 * メタデータ全体に許可される最大文字数は**2047**文字です。文字数の算出には、キーバリューペアの定義に使用されるコロン「:」特殊文字も含まれます。 const objectMeta = { "key1": "value1" , "key2": "value2" }; const objMeta = await objectIns.putMeta(objectMeta); console.log(objMeta); **レスポンス例** { "message": "Metadata added successfully" } ##### ZCQL -------------------------------------------------------------------------------- title: "ZCQL インスタンスの取得" description: "このページでは、NodeJSアプリケーションでData Storeのテーブルに対してZCQLクエリを実行するメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.336Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/zcql/get-component-instance/" service: "Cloud Scale" related: - ZCQL (/ja/cloud-scale/help/zcql/introduction) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # ZCQL ZCQLは、Catalyst Data Storeのテーブルに対してデータの取得、挿入、更新、削除操作を実行できるCatalyst独自のクエリ言語です。ZCQLを使用して、さまざまなDMLクエリを実行し、データの取得や操作を行うことができます。また、SQL Joinの句、GroupByおよびOrderByステートメント、組み込みSQL関数など、さまざまな句やステートメントを使用できます。 Catalystは、分析データ取得クエリに適した**OLAPデータベース**も、プライマリData Storeに加えて提供しています。プライマリData Storeでシンプルなトランザクションクエリを実行し、ZCQL関数を含む複雑な分析クエリをOLAPデータベースで実行することを選択できます。 ### コンポーネントインスタンスの取得 まず、ZCQLのコンポーネントインスタンスを作成する必要があります。zcqlインスタンスは以下のように作成できます。 //ZCQLインスタンスを取得する let zcql = app.zcql(); -------------------------------------------------------------------------------- title: "クエリの実行" description: "このページでは、NodeJSアプリケーションでData Storeのテーブルに対してZCQLクエリを実行するメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.336Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/zcql/execute-zcql-query/" service: "Cloud Scale" related: - Execute query - API (/ja/api/code-reference/cloud-scale/zcql/execute-zcql-query/#ExecuteZCQLQuery) - ZCQL (/ja/cloud-scale/help/zcql/introduction) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # クエリの実行 zcqlはこちらで定義されたコンポーネントインスタンスを参照します。これはPromiseを返し、オブジェクトに解決されます。contentキーに行オブジェクトの配列が含まれます。 ### プライマリData Storeでのクエリの構築と実行 プライマリData Storeで実行するZCQLクエリについては、クエリを構築し、以下に示すようにexecuteZCQLQuery()メソッドに渡すことができます。これらのクエリには、SELECT、INSERT、UPDATE、またはDELETEステートメントを含めることができます。 以下にサンプルのINSERTクエリを示します: //Construct the query to execute let query = 'INSERT into ShipmentData (productID, productName, region) VALUES (3782, A4 Reams, India)'; let result = await zcql.executeZCQLQuery(query); <br> ### OLAPデータベースでのクエリの構築と実行 OLAPデータベースで実行するクエリは、SELECTステートメントのみを含める必要があります。直接の書き込み操作は許可されていません。クエリオブジェクトを構築し、executeOLAPQuery()メソッドに渡すことができます。以下にサンプルの分析SELECTクエリを示します。 //Construct the query to execute let query = 'SELECT SUM(price) FROM ShipmentData'; let result = await zcql.executeOLAPQuery(query); ##### メール -------------------------------------------------------------------------------- title: "Mail インスタンスの取得" description: "このページでは、NodeJSアプリケーションからエンドユーザーにメールを送信するメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.336Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/mail/get-component-instance/" service: "Cloud Scale" related: - Mail (/ja/cloud-scale/help/mail/introduction) -------------------------------------------------------------------------------- # Catalyst Mail Catalyst Mailを使用すると、Catalystアプリケーションからエンドユーザーにメールを送信するために使用するビジネスのメールアドレスを追加できます。パブリックドメインまたは自組織のドメインのメールアドレスを設定できます。また、組み込みのCatalystメールクライアントを使用する代わりに、お好みの外部メールクライアントを使用し、そのSMTP設定をCatalystで構成することもできます。 #### コンポーネントインスタンスの取得 以下に示すようにemailの参照を作成できます。これはサーバーサイドの呼び出しを発生させません。このコンポーネントインスタンスは、メール送信操作を実行する際に参照します。 //Create an email instance let email = app.email(); -------------------------------------------------------------------------------- title: "メールの送信" description: "このページでは、NodeJSアプリケーションからエンドユーザーにメールを送信するメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.336Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/mail/send-email/" service: "Cloud Scale" related: - Send Email - API (/ja/api/code-reference/cloud-scale/mail/send-email/#SendEmail) - Mail (/ja/cloud-scale/help/mail/introduction) -------------------------------------------------------------------------------- # メールの送信 コンソールからドメイン、メールアドレス、およびお好みのメールクライアントのSMTP設定を構成する必要があります。ここに示すコードにより、Catalystアプリケーションから指定したメールアドレスにメールを送信できます。 Catalystでは、1回のメール送信操作で、複数のメールアドレスを受信者として設定し、CC、BCC、返信先を指定できます。また、メールにファイルを添付することもできます。1回のメール送信操作における最大サポート制限は以下のとおりです: * Toアドレス: 10 * CC: 10 * BCC: 5 * 返信先: 5 * 添付ファイル数: 5 * 添付ファイルサイズ: 15 MB（単一ファイルまたは最大5ファイルの合計） Note: 件名、送信者、および少なくとも1つの受信者メールアドレスは必須です。メールのその他の属性はオプションです。 #### JSON設定の作成 最初に、メールの必要な属性を含むJSONオブジェクトを作成する必要があります。これには、送信者のメールアドレスとメールのすべての受信者が含まれます。また、以下に示すように、createReadStream()メソッドを通じて添付ファイルのファイルストリームを作成し、メールの件名と本文を指定することもできます。 Note: メールを送信するには、Catalystコンソールで送信者のメールアドレスを構成および検証している必要があります。送信者のメールがプライベートドメインでホストされている場合、またはサードパーティのメールクライアントを使用する場合は、メール送信前にそれらも構成する必要があります。 以下のコードで使用されているemailの参照は、先に作成したコンポーネントインスタンスです。 let fs = require('fs');//Define the file stream for file attachments //メール設定のconfigオブジェクトを作成する let config = { from_email: 'emma@zylker.com', to_email:["vanessa.hyde@zoho.com","r.owens@zoho.com","chang.lee@zoho.com"], cc:["p.boyle@zylker.com","robert.plant@zylker.com"], bcc:["ham.gunn@zylker.com","rover.jenkins@zylker.com"], reply_to:["peter.d@zoho.com","arnold.h@zoho.com"], subject: 'Greetings from Zylker Corp!', content: "Hello,We're glad to welcome you at Zylker Corp. To begin your journey with us, please download the attached KYC form and fill in your details. You can send us the completed form to this same email address.We cannot wait to get started! Cheers! Team Zylker", attachments: [fs.createReadStream('kycform.pdf')] //create a file stream for the file attachment }; ### メールの送信 以下のコードに示すように、JSONオブジェクトをsendMail()メソッドの引数として渡す必要があります。これにより、メールの送信が開始されます。ここで返されるPromiseは、JSONとしてのオブジェクトに解決されます。 let mailPromise = await email.sendMail(config); console.log(mailPromise); Node.jsの各バージョンで受け取るサンプルレスポンスを以下に示します: { isAsync: false, project_details: { project_name: "Onboarding", id: "2136000000007733" }, from_email: "emma@zylker.com", to_email: ["vanessa.hyde@zoho.com","r.owens@zoho.com","chang.lee@zoho.com"], cc:["p.boyle@zylker.com","robert.plant@zylker.com"], bcc:["ham.gunn@zylker.com","rover.jenkins@zylker.com"], reply_to:["peter.d@zoho.com","arnold.h@zoho.com"], html_mode: true, subject: "Greetings from Zylker Corp!", content: "Hello, We're glad to welcome you at Zylker Corp. To begin your journey with us, please download the attached KYC form and fill in your details. You can send us the completed form to this same email address.We cannot wait to get started!Cheers!Team Zylker" } { isAsync: false, project_details: { project_name: "Onboarding", id: 2136000000007733 }, from_email: "emma@zylker.com", to_email: ["vanessa.hyde@zoho.com","r.owens@zoho.com","chang.lee@zoho.com"], cc:["p.boyle@zylker.com","robert.plant@zylker.com"], bcc:["ham.gunn@zylker.com","rover.jenkins@zylker.com"], reply_to:["peter.d@zoho.com","arnold.h@zoho.com"], html_mode: true, subject: "Greetings from Zylker Corp!", content: "Hello, We're glad to welcome you at Zylker Corp. To begin your journey with us, please download the attached KYC form and fill in your details. You can send us the completed form to this same email address.We cannot wait to get started!Cheers!Team Zylker" } ##### キャッシュ -------------------------------------------------------------------------------- title: "コンポーネントインスタンスの取得" description: "このページでは、NodeJS アプリケーションでキーまたはキャッシュオブジェクトを使用してキーと値のペアを削除する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.336Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/cache/get-component-instance/" service: "Cloud Scale" related: - Cache (/ja/cloud-scale/help/cache/introduction) -------------------------------------------------------------------------------- # コンポーネントインスタンスの取得 以下のメソッドを使用してキャッシュの参照を作成できます。このメソッドはサーバー側の呼び出しを実行しません。 //Get a cache instance let cache = app.cache(); -------------------------------------------------------------------------------- title: "セグメントインスタンスの取得" description: "このページでは、NodeJS アプリケーションでキャッシュセグメントインスタンスを取得する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.336Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/cache/get-segment-instance/" service: "Cloud Scale" related: - Cache (/ja/cloud-scale/help/cache/introduction) -------------------------------------------------------------------------------- # セグメントインスタンスの取得 以下のメソッドを使用して segment の参照を作成できます。このメソッドはサーバー側の呼び出しを実行しません。以下のコードスニペットで使用している cache の参照は、コンポーネントインスタンスです。 パラメータにセグメント ID を渡すと、その特定のセグメントを参照します。セグメント ID を指定しない場合は、デフォルトのセグメントを参照します。 //Refer a cache segment through the segment ID let cache = app.cache(); let segment = cache.segment(); -------------------------------------------------------------------------------- title: "キャッシュからのデータ取得" description: "このページでは、NodeJS アプリケーションでキャッシュからデータを取得する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.336Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/cache/retrieve-data-from-cache/" service: "Cloud Scale" related: - Retrieve data from the cache - API (/ja/api/code-reference/cloud-scale/cache/get-cache-value/#GetCacheValue) - Cache (/ja/cloud-scale/help/cache/introduction) -------------------------------------------------------------------------------- # キャッシュからのデータ取得 ### キャッシュ値の取得 Catalyst のキャッシュは、セグメントと呼ばれるパーティションまたはキャッシュ単位に分割されています。各セグメントは、キーと値のペアの形式でキャッシュアイテムを格納します。キーと値はいずれも String 型です。 getValue() メソッドを使用して、キャッシュ内のセグメントからキャッシュアイテムの値を取得できます。引数としてキー名を渡す必要があります。ここで返される Promise は、キーの実際の値である String に解決されます。 以下のコードスニペットで使用している segment の参照は、以前作成したセグメントインスタンスです。 //Get cache value by passing the key name let cache = app.cache(); let segment = cache.segment(); let cachePromise = segment.getValue('Age'); cachePromise.then((entity) => { console.log(entity); }); ### キャッシュオブジェクトの取得 キーと値のペアがオブジェクト型であるキャッシュの詳細を取得できます。キー名を引数として渡す _get()_ メソッドを使用してキーオブジェクトを取得します。以下のコードスニペットで使用している _segment_ の参照は、セグメントインスタンスです。ここで返される Promise は JSON であるオブジェクトに解決されます。 //Get Cache object by passing the key name as argument let cache = app.cache(); let segment = cache.segment(); let cachePromise = segment.get('Age'); cachePromise.then((entity) => { console.log(entity); }); 各バージョンで受信するサンプルレスポンスを以下に示します: { cache_name: "Name", cache_value: "Amelia Burrows", project_details: { project_name: "AlienCity", id: "2136000000007733" }, segment_details: { segment_name: "DataStore", id: "2136000000008572" }, expires_in: "Aug 18, 2021 06:39 PM", expiry_in_hours: "47", ttl_in_milliseconds: "172727000" } { cache_name: "Name", cache_value: "Amelia Burrows", project_details: { project_name: "AlienCity", id: 2136000000007733 }, segment_details: { segment_name: "DataStore", id: 2136000000008572 }, expires_in: "Aug 18, 2021 06:39 PM", expiry_in_hours: 47, ttl_in_milliseconds: 172609000 } -------------------------------------------------------------------------------- title: "キャッシュへのデータ挿入" description: "このページでは、NodeJS アプリケーションでキャッシュにデータを挿入する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.337Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/cache/insert-data-into-cache/" service: "Cloud Scale" related: - Insert data to cache - API (/ja/api/code-reference/cloud-scale/cache/insert-key-value-in-segment/#InsertKeyValueinCacheSegment) - Cache (/ja/cloud-scale/help/cache/introduction) -------------------------------------------------------------------------------- # キャッシュへのデータ挿入 put() メソッドを使用してキャッシュ要素を挿入できます。これにより、Catalyst プロジェクト内の既存のキャッシュセグメントにキーと値のペアを挿入できます。キー名とキー値は String 型で、メソッドの引数として渡します。 オプションでキャッシュ要素の有効期限を渡すこともできます。値を渡さない場合、有効期限はデフォルトで 48 時間に設定されます。 以下のコードスニペットで使用している segment の参照は、以前作成したセグメントインスタンスです。ここで返される Promise は JSON オブジェクトに解決されます。 //Insert Cache by passing the key-value pair let cache = app.cache(); let segment = cache.segment(); let cachePromise = segment.put('Name', 'Linda McCartney',1); //Expiry time for cache in hours cachePromise.then((entity) => { console.log(entity); }); 各バージョンで受信するサンプルレスポンスを以下に示します: { cache_name: "Last_Name", cache_value: "Smith", project_details: { project_name: "AlienCity", id: "2136000000007733" }, segment_details: { segment_name: "DataStore", id: "2136000000008572" }, expires_in: "Aug 18, 2021 06:46 PM", expiry_in_hours: "48", ttl_in_milliseconds: "172800000" } { cache_name: "Last_Name", cache_value: "Smith", project_details: { project_name: "AlienCity", id: 2136000000007733 }, segment_details: { segment_name: "DataStore", id: 2136000000008572 }, expires_in: "Aug 18, 2021 06:45 PM", expiry_in_hours: 48, ttl_in_milliseconds: 172800000 } -------------------------------------------------------------------------------- title: "キャッシュ内のデータ更新" description: "このページでは、Java アプリケーションでキャッシュ内のデータを更新する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.337Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/cache/update-data-in-cache/" service: "Cloud Scale" related: - Update Data in Cache - API (/ja/api/code-reference/cloud-scale/cache/update-key-value/#UpdateKey-ValuePair) - Cache (/ja/cloud-scale/help/cache/introduction) -------------------------------------------------------------------------------- # キャッシュ内のデータ更新 update() メソッドを使用して、キャッシュセグメント内のキーと値のペアを更新できます。String 型のキー名とキー値を引数として渡す必要があります。値が存在しない場合は、キャッシュセグメントに挿入されます。ここで返される Promise は JSON オブジェクトに解決されます。 オプションで有効期限パラメータを渡すこともできます。値を指定しない場合、有効期限はデフォルトで 48 時間に設定されます。 以下のコードスニペットで使用している segment の参照は、以前作成したセグメントインスタンスです。 //Update cache by passing the key-value pair let cache = app.cache(); let segment = cache.segment(); let cachePromise = segment.update('Name', 'Micheal Greene'); cachePromise.then((entity) => { console.log(entity); }); 各バージョンで受信するサンプルレスポンスを以下に示します: { cache_name: "Last_Name", cache_value: "Brown", project_details: { project_name: "AlienCity", id: "2136000000007733" }, segment_details: { segment_name: "DataStore", id: "2136000000008572" }, expires_in: "Aug 18, 2021 06:46 PM", expiry_in_hours: "47", ttl_in_milliseconds: "172596000" } { cache_name: "Last_Name", cache_value: "Brown", project_details: { project_name: "AlienCity", id: 2136000000007733 }, segment_details: { segment_name: "DataStore", id: 2136000000008572 }, expires_in: "Aug 18, 2021 06:46 PM", expiry_in_hours: 47, ttl_in_milliseconds: 172511000 } -------------------------------------------------------------------------------- title: "キーと値のペアの削除" description: "このページでは、NodeJS アプリケーションでキーまたはキャッシュオブジェクトを使用してキーと値のペアを削除する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.337Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/cache/delete-key-value-pair/" service: "Cloud Scale" related: - Cache (/ja/cloud-scale/help/cache/introduction) -------------------------------------------------------------------------------- # キーと値のペアの削除 キーと値のペアが不要になった場合、キャッシュセグメントから完全に削除できます。一度削除したキーと値のペアは復元できませんが、再作成は可能です。以下のコードスニペットで使用している _segment_ の参照は、セグメントインスタンスです。 ### キーを使用した削除 キーを _delete()_ メソッドのパラメータとして直接渡すことで、キーを削除できます。 ここで返される Promise は JSON であるオブジェクトに解決されます。 //delete Cache using delete by passing the key name let cache = app.cache(); let segment = cache.segment(); let deletePromise = segment.delete('Name'); deletePromise.then((entity) => { console.log(entity); }); ##### コネクション -------------------------------------------------------------------------------- title: "Connections インスタンスの取得" description: "このページでは、Connections SDK メソッドを使用するための Connections コンポーネントのインスタンスを取得する方法について説明します。" last_updated: "2026-06-10T06:04:54.337Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/connections/get-connections-instance/" service: "Cloud Scale" related: - Connections Help (/ja/cloud-scale/help/connections/introduction/) - Connections Java SDK (/ja/sdk/java/v1/cloud-scale/connections/get-connections-instance/) - Connections Python SDK (/ja/sdk/python/v1/cloud-scale/connections/get-connections-instance/) -------------------------------------------------------------------------------- # Connections Connections を使用すると、すべての認証トークン要件を管理しながら、Zoho およびその他のサードパーティサービスと統合できます。 ### Connections インスタンスの取得 Note: この SDK は、Functions や AppSail などの Catalyst サービス内でのみアクセスできます。サードパーティサービスとの統合には使用できません。 以下に示すように、connections コンポーネントの参照を取得できます。これはサーバー側の呼び出しを実行しません。このコンポーネントインスタンスは、Connections の各種コードスニペットで使用します。 // 接続インスタンスを作成 const connections = app.connections(); -------------------------------------------------------------------------------- title: "認証資格情報の取得" description: "このページでは、Connections SDK メソッドを使用するための Connections コンポーネントのインスタンスを取得する方法について説明します。" last_updated: "2026-06-10T06:04:54.337Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/connections/get-credentials/" service: "Cloud Scale" related: - Connections Help (/ja/cloud-scale/help/connections/introduction/) - Connections Java SDK (/ja/sdk/java/v1/cloud-scale/connections/get-credentials/) - Connections Python SDK (/ja/sdk/python/v1/cloud-scale/connections/get-credentials/) -------------------------------------------------------------------------------- # 認証資格情報の取得 Note: この SDK は、Functions や AppSail などの Catalyst サービス内でのみアクセスできます。サードパーティサービスとの統合には使用できません。 この SDK メソッドを使用して、Default Services として一覧表示されている各種 Zoho サービスの認証資格情報を取得できます。 以下のコードスニペットで使用している connections の参照は、コンポーネントインスタンスです。 // 接続インスタンスを作成 const connections = app.connections(); // 指定された接続の認証資格情報を取得する const connectionResponse = connections.getConnectionCredentials('payrollcon'); // 接続レスポンス console.log('connection response: ', connectionResponse); ##### プッシュ通知 -------------------------------------------------------------------------------- title: "プッシュ通知インスタンスの取得" description: "このページでは、NodeJSアプリケーションからエンドユーザーにリモート通知を送信するメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.337Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/push-notifications/get-component-instance/" service: "Cloud Scale" related: - Push notifications (/ja/cloud-scale/help/push-notifications/introduction) -------------------------------------------------------------------------------- # Push Notifications Catalyst Push notificationsを使用すると、アプリがユーザーのデバイスでアクティブに実行されていない場合でも、アプリケーションのユーザーにリモート通知を送信できます。特定のターゲットユーザーリストにプッシュ通知を送信できます。アラート、更新情報、またはプロモーションコンテンツを含めて、ユーザーがアプリケーションに関与できるようにすることができます。 プッシュ通知を送信する前に、ユーザーが許可した際にWebアプリで有効にする必要があります。これは、Webクライアントにこのコードスニペットを実装することで行えます。また、CatalystリモートコンソールのPush Notificationsセクションからこのコードにアクセスすることもできます。Web初期化スクリプトを含めることを確認してください。 ### コンポーネントインスタンスの取得 以下に示すようにpushNotificationコンポーネントの参照を作成できます。これはサーバーサイドの呼び出しを発生させません。このコンポーネントインスタンスは、プッシュ通知を送信する際に参照します。 //Get a pushNotification instance const pushNotification = app.pushNotification(); -------------------------------------------------------------------------------- title: "ウェブアプリへの通知送信" description: "このページでは、NodeJSアプリケーションからエンドユーザーにリモート通知を送信するメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.337Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/push-notifications/send-notifications/" service: "Cloud Scale" related: - Send Notifications - API (/ja/api/code-reference/cloud-scale/push-notifications/web/send-web-push-notifications/#SendWebNotifications) - Push Notifications (/ja/cloud-scale/help/push-notifications/introduction) -------------------------------------------------------------------------------- # Webアプリへのプッシュ通知の送信 Catalystでは、1回の関数呼び出しで50人のユーザーにプッシュ通知を送信できます。以下に示すように、通知対象のすべてのユーザーのユーザーIDを配列に追加できます。次に、通知に含めるメッセージ文字列と共に、配列をsendNotification()メソッドに渡す必要があります。この文字列は、プレーンテキスト、HTML、またはパースされるJSONオブジェクトにすることができます。 ここで使用されているpushNotificationインスタンスは、コンポーネントインスタンスです。 var userList = []; //すべてのユーザーのユーザーIDを含める userList.push(1234556789098); userList.push(6756467677890); userList.push(3557866876887); catalystApp.pushNotification().web().sendNotification("Hi there! The task you scheduled has been completed.", userList); //メッセージ文字列を含む配列を渡す また、ユーザーIDの代わりにメールアドレスを含めて通知を送信することもできます。メールアドレスを配列に追加し、同じ方法でメッセージ文字列と共にsendNotification()に渡す必要があります。 var userList = []; //ユーザーのメールアドレスを含める userList.push("emma@zylker.com"); userList.push("p.boyle@zylker.com"); userList.push("noel@zylker.com"); catalystApp.pushNotification().web().sendNotification("Hi there! The task you scheduled has been completed.", userList); //メッセージ文字列を含む配列を渡す -------------------------------------------------------------------------------- title: "モバイルアプリへの通知送信" description: "このページでは、NodeJSアプリケーションからエンドユーザーにリモート通知を送信するメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.337Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/push-notifications/send-notifications-mobile/" service: "Cloud Scale" related: - Push Notifications (/ja/cloud-scale/help/push-notifications/introduction) -------------------------------------------------------------------------------- # モバイルアプリへのプッシュ通知 Catalyst Cloud Scale Push Notificationsコンポーネントを使用すると、AndroidまたはiOSプラットフォーム上に構築されたモバイルアプリケーションに通知を送信できます。CatalystユーザーIDまたはメールアドレスを使用して、特定のターゲットユーザーにプッシュ通知を送信できます。アラート、更新情報、またはプロモーションコンテンツを含めて、ユーザーがアプリケーションに関与できるようにすることができます。 プッシュ通知を設定するには、以下の前提条件を満たす必要があります: 1. モバイルアプリケーションをCatalystに登録し、設定後にコンソールからApplication ID（appId）をメモする必要があります。ターゲットデバイスにインストールされたアプリケーションの登録は、個別のプラットフォーム固有のCatalyst Mobile SDKメソッド（AndroidおよびiOSで利用可能）またはFlutter SDKを使用して行えます。 appIdは、Catalystコンソールで直接Android Push Notificationsサービスを設定することで取得できます。 Android SDKを使用したAndroidアプリの登録について学ぶ。 iOS SDKを使用したiOSアプリの登録について学ぶ。 Flutter SDKを使用したモバイルアプリ（AndroidまたはiOS）の登録について学ぶ。 2. モバイルアプリケーションは、Catalyst Serverless Authenticationコンポーネントを必ず使用する必要があります。 すべての設定が完了すると、Catalystユーザーは通知を迅速に受信するためにデバイスにログインしている必要があります。 設定が完了したら、生成されたApplication IDを使用して、以下のNode.js SDKメソッドを呼び出すことで、特定のアプリをターゲットにして通知を送信できます。 ### モバイル通知インスタンスの取得 モバイル通知インスタンスを作成し、Catalystコンソールに登録された特定のモバイルアプリを参照するために使用できます。これは、 pushNotification().mobile() メソッドで生成されたappIDをパラメータとして渡すことで、モバイル通知インスタンスを取得して行います。 このモバイル通知インスタンスを使用して、次のセクションで説明するプッシュ通知の送信など、Node.js SDKメソッドで追加の操作を実行します。 const notification = app.pushNotification().mobile("1234567890"); ここで、1234567890はappIDです。また、アプリケーションがCatalystスコープベースのアクセスを含む場合は、appIDと共にZCProject projectパラメータを渡すことができます。 Catalyst SDKスコープの詳細を学ぶ。 const notification = app.pushNotification().mobile("1234567890", ZCProject project); #### Androidプッシュ通知の送信 Androidアプリケーションをプッシュ通知送信用にCatalystに登録した後、sendAndroidNotification()メソッドを使用してアプリケーションにプッシュ通知を送信できます。 sendAndroidNotification()メソッドに2つのパラメータを渡す必要があります: MobileNotification.sendAndroidNotification(notifyObj: ICatalystPushDetails, recipient: string): Promise<ICatalystMobileNotification> * notifyObj - プッシュ通知メッセージの詳細を含むオブジェクトです。 * recipient - メッセージを配信する受信者のCatalystユーザーIDまたはメールアドレスです。 アプリケーションでsendAndroidNotification()メソッドを呼び出すには、以下のコードスニペットを使用できます: notification.sendAndroidNotification({ message: 'This message is to test if the functionality is working fine!', badge_count: 1 }, 'emma.b@zylker.com'); badge_countはアプリアイコンの通知バッジカウントを1に設定します。この値は必要に応じて任意の数に変更できます。 #### iOSプッシュ通知の送信 iOSアプリケーションをプッシュ通知送信用にCatalystに登録した後、sendIOSNotification()メソッドを使用してアプリケーションにプッシュ通知を送信できます。 sendIOSNotification()メソッドに2つのパラメータを渡す必要があります: MobileNotification.sendIOSNotification(notifyObj: ICatalystPushDetails, recipient: string): Promise<ICatalystMobileNotification> アプリケーションでsendIOSNotification()メソッドを呼び出すには、以下のコードスニペットを使用できます: notification.sendIOSNotification({ message: 'This message is to test if the functionality is working fine!', badge_count: 1 }, 'emma@zylker.com'); ##### 検索 -------------------------------------------------------------------------------- title: "検索インスタンスの取得" description: "このページでは、NodeJSアプリケーションで複数のテーブルのデータを検索するメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.337Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/search/get-a-component-instance/" service: "Cloud Scale" -------------------------------------------------------------------------------- # Search ### 検索インデックス付きカラムのデータ検索 検索プロセスは、テーブルの検索インデックス付きカラムで検索するパターンを指定します。複数のテーブルのデータや、検索インデックス付きカラムのデータのみを検索できます。 検索の詳細については、こちらの情報をご参照ください。 ### コンポーネントインスタンスの取得 searchの参照は、以下のメソッドを使用して作成できます。このメソッドはサーバーサイドの呼び出しを発生させません: //Get an search instance let search = app.search(); -------------------------------------------------------------------------------- title: "データの検索" description: "このページでは、NodeJSアプリケーションで複数のテーブルのデータを検索するメソッドについて、サンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.337Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/search/search-data/" service: "Cloud Scale" related: - Search Data - API (/ja/api/code-reference/cloud-scale/search/execute-search-query/#ExecuteSearchQuery) - Search Integration (/ja/cloud-scale/help/search-integration/introduction) -------------------------------------------------------------------------------- # データの検索 Catalyst Searchを使用すると、Catalyst Data Storeからデータレコードを検索および取得できます。executeSearchQuery()メソッドを使用して、特定のデータパターンを検索するための検索クエリを実行できます。コードスニペットで使用されているsearchの参照は、コンポーネントインスタンスです。 #### JSON設定の作成 以下のコードスニペットは、個々のテーブルのインデックス付きカラムで検索するパターンの属性を含むJSONオブジェクトを作成します。 //Create a config object with the search term, table and indexed columns let config = { search: 'santh\*',search_table_columns: { SampleTable: ['SearchIndexedColumn'], Users: ['SearchTest'] } }; ### 検索クエリの実行 前のセクションで作成したJSONオブジェクトを_executeSearchQuery()_メソッドのパラメータとして渡すと、Promiseが返されます。返されるPromiseは、JSONであるオブジェクトに解決されます。 //Execute the search query by passing the configuration let search = app.search(); let searchPromise = search.executeSearchQuery(config); searchPromise.then(searchResult => { console.log(searchResult); }); 受け取るサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 #### Node.js { AlienCity: [ { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-13 13:49:19:475", CityName: "Dallas", CREATEDTIME: "2021-08-13 13:49:19:475", ROWID: "2136000000008508" } ] } ##### 認証 -------------------------------------------------------------------------------- title: "Authentication インスタンスの取得" description: "このページでは、NodeJS アプリケーションでコンポーネントインスタンスを作成する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.338Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/authentication/get-component-instance/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # 認証 Node.js SDK のCatalyst Authentication機能を使用すると、Catalyst サーバーレスアプリケーションにエンドユーザーを追加したり、ユーザーの詳細を取得したり、パスワードを管理したり、ユーザーを完全に削除したりできます。ユーザーアカウントとロールの追加設定を行い、リモートコンソールからアプリケーションの認証を管理できます。 ### コンポーネントインスタンスの取得 以下に示すように、userManagement コンポーネントの参照を作成できます。これはサーバー側の呼び出しを実行しません。このコンポーネントインスタンスは、Authentication の各種コードスニペットで使用します。 //ユーザー管理インスタンスを取得する let userManagement = app.userManagement(); -------------------------------------------------------------------------------- title: "新規ユーザーの追加" description: "このページでは、NodeJS アプリケーションに新しいエンドユーザーを追加する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.338Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/authentication/add-new-user/" service: "Cloud Scale" related: - Add new user - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # 新規ユーザーの追加 Catalyst サーバーレスアプリケーションにエンドユーザーを追加し、ユーザーの詳細を取得したり、アカウントを簡単に管理したりできます。ユーザーが Catalyst アプリケーションにサインアップすると、ZUID や User ID などの一意の識別値が作成されます。また、この方法ではユーザーは自動的に組織に割り当てられます。 #### JSON 設定の作成 Catalyst アプリケーションに新しいエンドユーザーを追加する前に、以下に示すように、特定のユーザーのメールアドレス、姓、アプリケーションプラットフォーム、割り当てるロールなどの登録情報を含む JSON オブジェクトを作成する必要があります。その後、この設定をユーザー登録メソッドに渡すことができます。 Note: * ユーザーを登録するには、email_id と first_name の値を必ず指定する必要があります。 * role_id は、Catalyst コンソールの _Authentication_ 内の _Roles_ セクションから取得できます。 //Create a JSON object for adding a new user const signupConfig = { platform_type: 'web', template_details: { senders_mail:'dogogetu@tutuapp.bid', subject:'Welcome to %APP_NAME% ', message:'&lt;p&gt;Hello ,&lt;/p&gt; &lt;p&gt;Follow this link to join in %APP_NAME% .&lt;/p&gt; &lt;p&gt; &lt;a href=\'%LINK%\'&gt;%LINK%&lt;/a&gt; &lt;/p&gt; &lt;p&gt;If you did not ask to join the application, you can ignore this email.&lt;/p&gt; &lt;p&gt;Thanks,&lt;/p&gt; &lt;p&gt;Your %APP_NAME% team&lt;/p&gt;' }, redirect_url: 'home.html' // 認証後、ユーザーはこのページに誘導されます。招待URLとして設定したカスタムドメインも指定できます。 }; var userConfig = { first_name: 'Dannie', last_name: 'Boyle', email_id: 'p.boyle@zylker.com', role_id : '3376000000159024' }; ### 新規ユーザーの追加 以下のコードを使用して、Catalyst アプリケーションに新しいエンドユーザーを追加できます。前のセクションで作成した JSON オブジェクトを registerUser() メソッドの引数として渡す必要があります。 registerUser() メソッドはユーザーのサインアッププロセスを処理し、Promise を返します。この Promise は JSON オブジェクトに解決されます。 以下で使用している userManagement の参照は、コンポーネントインスタンスページで定義されています。 Note : 開発環境では、アプリケーションに追加できるユーザーは 25 名までです。アプリケーションを本番環境にデプロイした後は、任意の数のエンドユーザーを追加できます。 let userManagement = app.userManagement(); let registerPromise = userManagement.registerUser(signupConfig, userConfig); //JSON設定をメソッドに渡す registerPromise.then(userDetails =&gt; { //Promiseを返す console.log(userDetails); }); 各バージョンで受信するサンプルレスポンスを以下に示します: { zaid: "1005634498", user_details: { zuid: "1005641290", zaaid: "1005641456", org_id: "1005641456", status: "ACTIVE", is_confirmed: false, email_id: "p.boylie@zylker.com", first_name: "Dannie", last_name: "Boyle", created_time: "Aug 12, 2021 12:33 PM", modified_time: "Aug 12, 2021 12:33 PM", invited_time: "Aug 12, 2021 12:33 PM", role_details: { role_name: "App User", role_id: "2305000000006024" }, user_type: "App User", user_id: "2305000000007752", project_profiles: [] }, redirect_url: "https://aliencity-66446133.development.catalystserverless.com/app/", platform_type: "web", org_id: null } { zaid: 1005634498, user_details: { zuid: 1005641433, zaaid: 1005641434, org_id: 1005641434, status: "ACTIVE", is_confirmed: false, email_id: "p.boyle@zylker.com", last_name: "Boyle", first_name: "Dannie", created_time: "Aug 12, 2021 12:27 PM", modified_time: "Aug 12, 2021 12:27 PM", invited_time: "Aug 12, 2021 12:27 PM", role_details: { role_name: "App User", role_id: 2305000000006024 }, user_type: "App User", user_id: 2305000000007745, project_profiles: [] }, redirect_url: "https://aliencity-66446133.development.catalystserverless.com/app/", platform_type: "web", org_id: null } -------------------------------------------------------------------------------- title: "すべての Org ID の取得" description: "このページでは、NodeJS アプリケーションにサインアップしたユーザーに関連付けられたすべての Org ID を取得する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.338Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/authentication/get-org-id/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - User Management (/ja/cloud-scale/help/authentication/user-management/users/introduction/) -------------------------------------------------------------------------------- # すべての Org ID の取得 Org ID（ZAAID）は、エンドユーザーが所属する組織の一意の識別子です。この識別子は、エンドユーザーがいずれかの認証タイプを通じてアプリケーションにサインアップしたとき、Add User API を通じて追加されたとき、またはコンソールのAdd User ボタンを通じて追加されたときに生成されます。 以下の SDK スニペットは、getAllOrgs() メソッドを使用して、アプリケーションに新しいユーザーを追加する際に生成されたすべての Org ID を取得する方法を示しています: const userManagement = app.userManagement(); userManagement.getAllOrgs() -------------------------------------------------------------------------------- title: "既存組織へのユーザー追加" description: "このページでは、NodeJS アプリケーションで既存の組織に新しいユーザーを追加する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.338Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/authentication/add-new-user-to-existing-org/" service: "Cloud Scale" related: - Add new user to existing org - API (/ja/api/code-reference/cloud-scale/authentication/add-user-to-existing-org/#AddaNewUsertoanExistingOrganization) - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # 既存組織への新規ユーザーの追加 エンドユーザーを既存の組織に追加でき、新しい組織を作成する必要はありません。これは、ユーザーを追加する組織の **OrgID** を指定することで実行できます。ユーザーのアカウントに関連付けられた組織は、後から変更することはできません。 ユーザーがサインアップすると、ZUID や User ID などの一意の識別値が作成されます。 * 既存の組織にユーザーを追加するには、OrgID、email_id、first_name の値を必ず指定する必要があります。 * role_id を指定してロールに追加することもできます。role_id は Catalyst コンソールの Authentication 内の Roles セクションから取得できます。 * 新しいユーザーを招待する際、送信者のメールアドレス、件名、メールメッセージを設定できます。SDK コードで使用する前に、Catalyst Mail Component でメールアドレスを追加し、認証を完了させる必要があります。 ### JSON 設定の作成 Catalyst アプリケーションに新しいエンドユーザーを追加する前に、以下に示すように、特定のユーザーの登録情報を含む JSON オブジェクトを作成する必要があります。その後、この設定をユーザー登録メソッドに渡すことができます。 //既存の組織に新しいユーザーを追加するJSONオブジェクトを作成する const signupConfig = { platform_type: 'web', template_details: { 'senders_mail':'dogogetu@tutuapp.bid', 'subject':'Welcome to %APP_NAME% ', 'message':'&lt;p&gt;Hello ,&lt;/p&gt; &lt;p&gt;Follow this link to join in %APP_NAME% .&lt;/p&gt; &lt;p&gt;&lt;a href=\'%LINK%\'&gt;%LINK%&lt;/a&gt;&lt;/p&gt; &lt;p&gt;If you didn't ask to join the application, you can ignore this email.&lt;/p&gt; &lt;p&gt;Thanks,&lt;/p&gt; &lt;p&gt;Your %APP_NAME% team&lt;/p&gt;' }}; var userConfig = { first_name: 'Amelia', last_name: 'Burrows', email_id: 'emma@zylker.com', org_id: 10014774358 }; ### 既存組織への新規ユーザーの追加 以下のコードを使用して、既存の組織に新しいエンドユーザーを追加できます。前のセクションで作成した JSON オブジェクトを addUserToOrg() メソッドの引数として渡す必要があります。このメソッドはユーザーのサインアッププロセスを処理し、Promise を返します。この Promise は JSON オブジェクトに解決されます。 コードで使用している userManagement の参照は、以前作成したコンポーネントインスタンスです。 開発環境では、アプリケーションに追加できるユーザーは 25 名までです。アプリケーションを本番環境にデプロイした後は、任意の数のエンドユーザーを追加できます。 let userManagement = app.userManagement(); let addUserPromise = userManagement.addUserToOrg(signupConfig, userConfig); //JSON設定をメソッドに渡す addUserPromise.then(addedUser => { //Promiseを返す console.log(addedUser); }); 各バージョンで受信するサンプルレスポンスを以下に示します: { zaid: "1005634498", user_details: { zuid: "1005643749", org_id: "10014774358", status: "ACTIVE", is_confirmed: false, email_id: "emma@zylker.com", first_name: "Amelia", last_name: "Burrows", created_time: "Aug 12, 2021 03:56 PM", modified_time: "Aug 12, 2021 03:56 PM", invited_time: "Aug 12, 2021 03:56 PM", role_details: { role_name: "App User", role_id: "2305000000006024" }, user_type: "App User", user_id: "2305000000009002", project_profiles: [] }, redirect_url: "https://aliencity-66446133.development.catalystserverless.com/app/", platform_type: "web", org_id: null } { zaid: 1005634498, user_details: { zuid: 1005643930, org_id: "10014774358", status: "ACTIVE", is_confirmed: false, email_id: "emma@zylker.com", first_name: "Amelia", last_name: "Burrows", created_time: "Aug 12, 2021 04:05 PM", modified_time: "Aug 12, 2021 04:05 PM", invited_time: "Aug 12, 2021 04:05 PM", role_details: { role_name: "App User", role_id: 2305000000006024 }, user_type: "App User", user_id: 2305000000009004, project_profiles: [] }, redirect_url: "https://aliencity-66446133.development.catalystserverless.com/app/", platform_type: "web", org_id: null } -------------------------------------------------------------------------------- title: "組織内のすべてのユーザーの取得" description: "このページでは、NodeJS アプリケーションで既存の組織に新しいユーザーを追加する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.338Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/authentication/get-users-in-org/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - User Management (/ja/cloud-scale/help/authentication/user-management/users/introduction/) -------------------------------------------------------------------------------- # 組織内のすべてのユーザーの取得 以下の SDK スニペットは、getAllUsers(Org ID) メソッドを使用して、組織に割り当てられたすべてのユーザーのリストを取得する方法を示しています。 const userManagement = app.userManagement(); userManagement.getAllUsers('10062701096'); // ここに組織IDを入力してください -------------------------------------------------------------------------------- title: "パスワードのリセット" description: "このページでは、NodeJS アプリケーションでユーザーアカウントのパスワードをリセットする方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.338Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/authentication/reset-password/" service: "Cloud Scale" related: - Reset password - API (/ja/api/code-reference/cloud-scale/authentication/reset-user-password/#ResetUserPassword) - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # パスワードのリセット ユーザーの登録が成功した後、以下のコードスニペットを使用してパスワードをリセットできます。resetPassword() メソッドを呼び出すと、パスワードリセットリンクが生成され、ユーザーのメールアドレスに送信されます。以下のコードスニペットで使用している userManagement の参照は、コンポーネントインスタンスです。 Note: * **EmailID** と **Platform type** は必須の属性です。 * 送信者のメールアドレス、件名、メールメッセージを設定できます。SDK コードで使用する前に、Catalyst Mail Component でメールアドレスを追加し、認証を完了させる必要があります。 ### 設定 JSON の作成 特定のユーザーの登録情報を含む JSON オブジェクトを以下のように作成します。 //ユーザーの設定オブジェクトを作成する const signupConfig = { platform_type: 'web', zaid: 10014774358, template_details: { 'senders_mail':'dogogetu@tutuapp.bid', 'subject':'Welcome to %APP_NAME% ', 'message':'&lt;p&gt;Hello ,&lt;/p&gt; &lt;p&gt;Follow this link to join in %APP_NAME% .&lt;/p&gt; &lt;p&gt;&lt;a href=\'%LINK%\'&gt;%LINK%&lt;/a&gt;&lt;/p&gt; &lt;p&gt;If you didn't ask to join the application, you can ignore this email.&lt;/p&gt; &lt;p&gt;Thanks,&lt;/p&gt; &lt;p&gt;Your %APP_NAME% team&lt;/p&gt;' } }; var userConfig = { first_name: 'A', last_name: 'B', email_id: 'amelia.burrows@zylker.com' }; ### パスワードのリセット これらのオブジェクトは registerUser() メソッドの引数として渡され、Promise が返されます。 返される Promise は JSON であるオブジェクトに解決されます。 const userManagement = app.userManagement(); let users = await userManagement.resetPassword('amelia.b@zylker.com', { 'platform_type': 'web', 'redirect_url': 'https://www.google.com', 'template_details': { 'subject': 'Reset Password', 'message': 'Click on the link to reset your password: <a href="{{reset_password_url}}">Reset Password</a>', 'senders_mail': 'support@zylker.com' } }); console.log(users); -------------------------------------------------------------------------------- title: "カスタムサーバートークンの生成" description: "このページでは、NodeJS アプリケーションからユーザーを削除する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.338Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/authentication/third-party-server-token/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # カスタムサーバートークンの生成 Cloud Scale の Authentication コンポーネントでは、Catalyst アプリケーションに任意のサードパーティ認証サービスを実装できます。エンドユーザーの認可とバリデーションはサードパーティサービスによって処理され、データは Catalyst に渡されます。 Note: * サードパーティの認証サービスを実装するため、アプリケーションのセキュリティインフラストラクチャは、選択したサードパーティサービスの効率性に依存することをご理解ください。 * Catalyst アプリケーションでサードパーティ認証を有効にするには、コンソールで Public Signup を有効にする必要があります。 サードパーティサービスで認証された後にユーザーがリダイレクトされると、ユーザーの資格情報をコーディングした認証関数に渡す必要があります。この関数には、カスタムサーバートークンを生成する Catalyst サーバーサイドスクリプトを含める必要があり、生成されたトークンはクライアントコードに組み込まれた Web SDK に渡されます。 const userManagement = catalystApp.userManagement(); userManagement.generateCustomToken({ type:'web', user_details:{ email_id: "${email_id}", first_name: "${first_name}", last_name: "${last_name}", org_id: "${org_id}", phone_number: "${phone_number}", country_code: "${country_code}", role_name: "${role_name}" } }); このトークンを、Web SDK ヘルプページで説明されているとおり、クライアントロジックに渡すことができます。 Note : カスタムサーバートークンは、ユーザーがサードパーティ認証サービスを使用してアプリケーションにログインするたびに生成する必要があります。 -------------------------------------------------------------------------------- title: "カスタムユーザーバリデーション" description: "このページでは、NodeJS アプリケーションからユーザーを削除する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.338Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/authentication/custom-user-validation/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # カスタムユーザーバリデーション Catalyst Authentication では、Catalyst アプリケーションへのサインアップ時に、カスタムのBasic I/O functionを使用してエンドユーザーを認可およびバリデーションできます。この関数を通じてユーザーが提供する資格情報を処理する独自のロジックを記述し、アプリケーションへのアクセスを許可できます。 Custom User Validation 関数のサンプルコードを以下に示します。 const catalyst = require('zcatalyst-sdk-node'); module.exports = (context, basicIO) => { const catalystApp = catalyst.initialize(context); const userManagement = catalystApp.userManagement(); const requestDetails = userManagement.getSignupValidationRequest(basicIO); if (requestDetails!==undefined) { if (requestDetails.user_details.email_id.includes('zylker.com')) { basicIO.write(JSON.stringify({ status: 'failure' })) } else { basicIO.write(JSON.stringify({ status: 'success', user_details: { first_name : 'CustomFirstName', last_name : 'CustomLastName', role_identifier : 'CustomRole', org_id : 'CustomOrgID'//組織IDを指定する場合は、コンソールから正確にコピーしてください。 } })) } } context.close(); } この関数をテストするには、以下の .JSON 形式でユーザーの詳細を渡します: { "request_type": "add_user", "request_details": { "user_details": { "email_id": "emmy@zylker.com", "first_name": "Emma", "last_name": "Thompson", "org_id": "432567817", "role_details": { "role_name": "Moderator", "role_id": "879" } }, "auth_type": "web" } } -------------------------------------------------------------------------------- title: "ユーザー詳細の取得" description: "このページでは、NodeJS アプリケーションの Data Store からユーザーの詳細を取得する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.338Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/authentication/get-user-details/" service: "Cloud Scale" related: - Get user details - API (/ja/api/code-reference/cloud-scale/authentication/get-specific-user/#GetSpecificUser) - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # ユーザー詳細の取得 Catalyst Authentication は、アプリケーションユーザーの詳細を取得するためのいくつかのメソッドを提供しています。現在のユーザー、特定のユーザー、またはアプリケーションのすべてのユーザーの情報を取得できます。 ### 現在のユーザーの詳細を取得 getCurrentUser() メソッドは、関数が実行されているスコープのユーザーの詳細を取得します。コードスニペットで使用している userManagement の参照は、以前作成したコンポーネントインスタンスです。 ここで返される Promise は JSON オブジェクトに解決されます。 // 現在のユーザーの詳細をPromiseとして取得 let userManagement = app.userManagement(); let userPromise = userManagement.getCurrentUser(); userPromise.then(currentUser => { console.log(currentUser); }); 各バージョンで受信するサンプルレスポンスを以下に示します: { zuid: "1005641433", zaaid: "1005641434", org_id: "1005641434", status: "ACTIVE", is_confirmed: false, email_id: "p.boyle@zylker.com", last_name: "Boyle", created_time: "Aug 12, 2021 12:27 PM", role_details: { role_name: "App User", role_id: "2305000000006024" }, user_type: "App User", user_id: "2305000000007745", locale: "us|en|Asia/Kolkata", time_zone: "Asia/Kolkata", project_profiles: [] } { zuid: 1005641433, zaaid: 1005641434, org_id: 1005641434, status: "ACTIVE", is_confirmed: false, email_id: "p.boyle@zylker.com", last_name: "Boyle", created_time: "Aug 12, 2021 12:27 PM", role_details: { role_name: "App User", role_id: 2305000000006024 }, user_type: "App User", user_id: 2305000000007745, locale: "us|en|Asia/Kolkata", time_zone: "Asia/Kolkata", project_profiles: [] } ### User ID によるユーザー詳細の取得 getUserDetails() メソッドにユーザーの User ID を渡すことで、特定のユーザーの詳細を取得できます。Promise は JSON オブジェクトに解決されます。 //Get a single user's details by passing the user ID let userManagement = app.userManagement(); let userPromise = userManagement.getUserDetails(1510000000109587); userPromise.then(userDetails => { console.log(userDetails); }); 各バージョンで受信するサンプルレスポンスを以下に示します: { zuid: "1005665160", zaaid: "1005665245", org_id: "1005665245", status: "ACTIVE", is_confirmed: false, email_id: "mikerogers@zylker.com ", last_name: "Rogers", created_time: "Aug 17, 2021 04:55 PM", role_details: { role_name: "App User", role_id: "2136000000007748" }, user_type: "App User", user_id: "2136000000020040", locale: "us|en|Asia/Kolkata", time_zone: "Asia/Kolkata", project_profiles: [] } { zuid: 1005665160, zaaid: 1005665245, org_id: 1005665245, status: "ACTIVE", is_confirmed: false, email_id: "mikerogers@zylker.com", last_name: "Rogers", created_time: "Aug 17, 2021 04:55 PM", role_details: { role_name: "App User", role_id: 2136000000007748 }, user_type: "App User", user_id: 2136000000020040, locale: "us|en|Asia/Kolkata", time_zone: "Asia/Kolkata", project_profiles: [] } ### すべてのユーザーの詳細を取得 getAllUsers() メソッドは、アプリケーションに登録されているすべてのユーザーの詳細を取得できます。 ここで返される Promise は、すべてのユーザーの詳細を含むオブジェクトの配列に解決されます。 //Get details of all users let userManagement = app.userManagement(); let allUserPromise = userManagement.getAllUsers(); allUserPromise.then(allUserDetails => { console.log(allUserDetails); }); 各バージョンで受信するサンプルレスポンスを以下に示します: [ { zuid: "1005648252", zaaid: "1005648253", org_id: "1005648253", status: "ACTIVE", is_confirmed: false, email_id: "p.boyle@zylker.com", last_name: "Boyle", created_time: "Aug 13, 2021 01:36 PM", modified_time: "Aug 13, 2021 01:36 PM", invited_time: "Aug 13, 2021 01:36 PM", role_details: { role_name: "App User", role_id: "2136000000007748" }, user_type: "App User", user_id: "2136000000007774", locale: "us|en|Asia/Kolkata", time_zone: "Asia/Kolkata", project_profiles: [] }, { zuid: "1005665160", zaaid: "1005665245", org_id: "1005665245", status: "ACTIVE", is_confirmed: false, email_id: "rsmith@zylker.com ", last_name: "Smith", created_time: "Aug 17, 2021 04:55 PM", modified_time: "Aug 17, 2021 04:55 PM", invited_time: "Aug 17, 2021 04:55 PM", role_details: { role_name: "App User", role_id: "2136000000007748" }, user_type: "App User", user_id: "2136000000020040", locale: "us|en|Asia/Kolkata", time_zone: "Asia/Kolkata", project_profiles: [] } ] [ { zuid: 1005648252, zaaid: 1005648253, org_id: 1005648253, status: "ACTIVE", is_confirmed: false, email_id: "p.boyle@zylker.com", last_name: "Boyle", created_time: "Aug 13, 2021 01:36 PM", modified_time: "Aug 13, 2021 01:36 PM", invited_time: "Aug 13, 2021 01:36 PM", role_details: { role_name: "App User", role_id: 2136000000007748 }, user_type: "App User", user_id: 2136000000007774, locale: "us|en|Asia/Kolkata", time_zone: "Asia/Kolkata", project_profiles: [] }, { zuid: 1005665160, zaaid: 1005665245, org_id: 1005665245, status: "ACTIVE", is_confirmed: false, email_id: "rsmith@zylker.com", last_name: "Smith", created_time: "Aug 17, 2021 04:55 PM", modified_time: "Aug 17, 2021 04:55 PM", invited_time: "Aug 17, 2021 04:55 PM", role_details: { role_name: "App User", role_id: 2136000000007748 }, user_type: "App User", user_id: 2136000000020040, locale: "us|en|Asia/Kolkata", time_zone: "Asia/Kolkata", project_profiles: [] } ] -------------------------------------------------------------------------------- title: "ユーザー詳細の更新" description: "このページでは、NodeJS アプリケーションでエンドユーザーの詳細を更新する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.339Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/authentication/update-user-details/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Modify a User's Details in the Console (/ja/cloud-scale/help/authentication/user-management/users/implementation/#modify-a-users-details) -------------------------------------------------------------------------------- # ユーザー詳細の更新 Catalyst では、エンドユーザーの以下の詳細を変更および更新できます: * First Name * Last name * **ZAAID**: **ZAAID**（Org ID）は、Catalyst が組織に関連付けるために生成する一意の値です。 * RoleID: Role ID は、特定のユーザーロールに割り当てられる Catalyst が生成した値です。 以下の SDK スニペットは、updateUserDetails(userID, userDetails) メソッドを使用してエンドユーザーの詳細を更新する方法を示しています。以下の例では、ユーザーの名前を更新しています。 const userManagement = app.userManagement(); userManagement.updateUserDetails('13749831', { email_id: 'emma@zylker.com', last_name: 'Burrows', zaaid: '1483013413294234', role_id: '843974989234859', first_name: 'Amelia' }); <br /> -------------------------------------------------------------------------------- title: "ユーザーの有効化または無効化" description: "このページでは、NodeJS アプリケーションでユーザーを有効化または無効化する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.339Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/authentication/enable-disable-user/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) - Enable or Disable a User in the Console (/ja/cloud-scale/help/authentication/user-management/users/implementation/#enable-or-disable-a-user) -------------------------------------------------------------------------------- # ユーザーの有効化または無効化 Catalyst では、いつでもユーザーを無効化または有効化できます。無効化されたユーザーはアプリケーションにサインアップされていますが、アプリケーションにアクセスすることはできません。 以下の SDK スニペットは、updateUserStatus(userId, USER_STATUS) メソッドを使用してエンドユーザーを有効化および無効化する方法を示しています。 ユーザーは一意のUser IDで参照されます。すべてのユーザーの User ID は、Authentication コンポーネントの *Users* > *User Management* セクションに移動して確認できます。 ### ユーザーの有効化 const userManagement = app.userManagement(); userManagement.updateUserStatus('195000000042777', USER_STATUS.ENABLE) ### ユーザーの無効化 const userManagement = app.userManagement(); userManagement.updateUserStatus('195000000042777', USER_STATUS.DISABLE) <br /> -------------------------------------------------------------------------------- title: "ユーザーの削除" description: "このページでは、NodeJS アプリケーションからユーザーを削除する方法について、サンプルコードとともに説明します。" last_updated: "2026-06-10T06:04:54.339Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/cloud-scale/authentication/delete-user/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # ユーザーの削除 Catalyst アプリケーションのエンドユーザーを削除して、アプリケーションへのアクセスを停止できます。これは deleteUser() メソッドを使用して行います。このメソッドには、削除するユーザーの User ID をパラメータとして渡します。 ここで返される Promise は、JSON であるオブジェクトに解決されます。 //Delete a single user by passing the user ID which in turn returns a promise let userManagement = app.userManagement(); let deleteUserPromise = userManagement.deleteUser(1510000000109587); deleteUserPromise.then(deletedUser => { console.log(deleteUserPromise); }); #### Job Scheduling -------------------------------------------------------------------------------- title: "概要" description: "このページでは、Job Scheduling操作を実行するメソッドについて説明します" last_updated: "2026-06-10T06:04:54.339Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/overview/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/overview/) - Python SDK (/ja/sdk/python/v1/job-scheduling/overview/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # Job Scheduling SDK Job Schedulingは、ジョブの送信をスケジュールし、Job Pool内で実行してCircuits、Webhooks（任意のサードパーティURL）、Job Functions、およびApp SailサービスのエンドポイントをトリガーできるCatalystサービスです。 Catalyst SDKを使用して、コードで以下の操作を実行できます： <table class="content-table"> <thead> <tr> <th class="w25p">Job Schedulingコンポーネント</th> <th class="w75p">SDKで実行可能な操作</th> </tr> </thead> <tbody> <tr> <td>Job Pool</td> <td>すべてのJob Poolの取得<br />特定のJob Poolの取得</td> </tr> <tr> <td>Job</td> <td>Jobの作成<br />Jobの詳細取得<br />Jobの削除</td> </tr> <tr> <td>Cron</td> <td>ワンタイムCronの作成<br />定期Cronの作成<br />Cron式を使用したCronの作成<br />特定のCronの詳細取得<br />すべてのCronの詳細取得<br />Cronの更新<br />Cronの一時停止<br />Cronの再開<br />Cronの実行<br />Cronの削除</td> </tr> </tbody> </table> <br /> -------------------------------------------------------------------------------- title: "Job Schedulingインスタンスの初期化" description: "このページでは、Job Schedulingサービスのコンポーネント参照を作成するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.339Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/initialize-job-scheduling-instance/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/initialize-job-scheduling-instance/) - Python SDK (/ja/sdk/python/v1/job-scheduling/initialize-job-scheduling-instance/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # Job Schedulingインスタンスの初期化 以下に示すように、Job Schedulingのコンポーネント参照を作成できます。これはサーバーサイドの呼び出しを実行しません。このコンポーネントインスタンスは、Job Schedulingのコンポーネントを操作するさまざまなコードスニペットで参照します。 const jobScheduling = app.jobScheduling(); // ジョブスケジューリングインスタンスを取得する ##### Cron -------------------------------------------------------------------------------- title: "ワンタイムCronの作成" description: "このページでは、サンプルコードスニペットを使用して、プロジェクト内にワンタイムCronを作成するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.339Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/cron/create-one-time-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/create-one-time-cron/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/create-one-time-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/create-cron/create-one-time-cron/#CreateaOne-TimeCron) -------------------------------------------------------------------------------- # ワンタイムCronの作成 Cronコンポーネントは、Job PoolへのJobの送信をスケジュールするために使用されます。以下のSDKを使用すると、ジョブの送信を1回だけスケジュールするCronを作成できます。 注意: 以下のSDKは、Job Functionをトリガーするジョブ用に記述されています。他のタイプに対応させるには、適切なJob Pool IDまたはJob Pool Nameに値を置き換え、適切なTarget NameまたはTarget IDを指定する必要があります。 // function jobメタデータを作成 const jobMeta = { job_name: 'test_job', // jobの名前を設定 target_type: 'Function', // function jobのターゲットタイプをFunctionに設定 target_name: 'target_function', // ターゲット関数の名前を設定（オプション）（target_idまたはtarget_nameは必須） // target_id: '123467890', // ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須） jobpool_name: 'test', // function jobpool名を設定（オプション）（jobpool_nameまたはjobpool_idは必須） // jobpool_id: '1234567890' // 関数ジョブプールのIDを設定する（オプション）（jobpool_nameまたはjobpool_idは必須） job_config: { number_of_retries: 2, // リトライ回数を設定 retry_interval: 15 * 60 // リトライ間隔を設定 }, // jobの設定 - リトライ => 15分で2回リトライ（オプション） params: { arg1: 'test', arg2: 'job' }, // ターゲット関数に渡すパラメータを設定（オプション） }; // ワンタイムcronの詳細を作成 const oneTimeCron = { cron_name: 'one_time', // cronの名前を設定（一意） description: 'one_time_cron', // cronの説明を設定（オプション） cron_status: true, // cronのステータスを有効に設定 cron_type: 'OneTime', // cronのタイプをOneTimeに設定 cron_detail: { time_of_execution: Math.floor(Date.now() / 1000) + (60 * 60) + '', // UNIX タイムスタンプとして実行時間を設定 // timezone: 'America/Los_Angeles' // タイムゾーンを設定する（オプション） }, job_meta: jobMeta // function jobメタデータを設定 }; // ワンタイムcronを作成 const cronDetails = await jobScheduling.CRON.createCron(oneTimeCron); 注意: このSDKは、Dynamic Cronsのみの設定に使用することを推奨します。Pre-defined Cronsの設定にはUI Builderを使用してください。 -------------------------------------------------------------------------------- title: "定期Cronの作成" description: "このページでは、サンプルコードスニペットを使用して、プロジェクト内に定期Cronを作成するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.339Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/cron/create-recurring-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/create-recurring-cron/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/create-recurring-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/create-cron/create-every-cron/#CreateanEveryCron) -------------------------------------------------------------------------------- # 定期Cronの作成 以下のSDKを使用すると、さまざまな時間間隔で実行できる定期Cronを作成できます。間隔は1分からカレンダー年単位まで設定できます。 ### Every Cronの作成 以下のSDKを使用して、**24時間未満**のスケジュール間隔でJob PoolにJobを送信する定期Cronを作成できます。 注意: 以下のSDKは、ジョブの送信を2時間1分3秒ごとに実行するよう設定されています。cron_detail JSONのキーと値のペアに適切な値を渡すことで、要件に応じてこの値を変更できます。 // function jobメタデータを作成 const jobMeta = { job_name: 'test_job', // jobの名前を設定 target_type: 'Function', // function jobのターゲットタイプをFunctionに設定 target_name: 'target_function', // ターゲット関数の名前を設定（オプション）（target_idまたはtarget_nameは必須） // target_id: '123467890', // ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須）jobpool_name: 'test', // function jobpool名を設定（オプション）（jobpool_nameまたはjobpool_idは必須） // jobpool_id: '1234567890' // 関数ジョブプールのIDを設定する（オプション）（jobpool_nameまたはjobpool_idは必須） job_config: { number_of_retries: 2, // リトライ回数を設定 retry_interval: 15 * 60 // リトライ間隔を設定 }, // jobの設定 - リトライ => 15分で2回リトライ（オプション） params: { arg1: 'test', arg2: 'job' }, // ターゲット関数に渡すパラメータを設定（オプション） }; // 定期cronの詳細を作成 const everyCron = { cron_name: 'every_cron', // cronの名前を設定（一意） description: 'every_cron', // cronの説明を設定（オプション） cron_status: true, // cronのステータスを有効に設定 cron_type: 'Periodic', // cronのタイプをPeriodicに設定（定期cron用） cron_detail: { hour: 2, // 繰り返しの時間間隔を設定 minute: 1, // 繰り返しの分間隔を設定 second: 3, // 繰り返しの秒間隔を設定 repetition_type: "every" // 繰り返しタイプをeveryに設定（定期cron用） }, job_meta: jobMeta // function jobメタデータを設定 }; // 定期cronを作成 const everyCronDetails = await jobScheduling.CRON.createCron(everyCron); <br> ### Daily Cronの作成 以下のSDKを使用して、**日単位の間隔**で固定時刻にJob Poolへのジョブ送信をスケジュールするCronを作成できます。 注意: 以下のSDKは、毎日0時0分0秒にCronを実行するよう設定されています。cron_detail JSONのキーと値のペアに適切な値を渡すことで、要件に応じてこの値を変更できます。 // function jobメタデータを作成 const jobMeta = { job_name: 'test_job', // jobの名前を設定 target_type: 'Function', // function jobのターゲットタイプをFunctionに設定 target_name: 'target_function', // ターゲット関数の名前を設定（オプション）（target_idまたはtarget_nameは必須） // target_id: '123467890', // ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須） jobpool_name: 'test', // function jobpool名を設定（オプション）（jobpool_nameまたはjobpool_idは必須） // jobpool_id: '1234567890' // 関数ジョブプールのIDを設定する（オプション）（jobpool_nameまたはjobpool_idは必須） job_config: { number_of_retries: 2, // リトライ回数を設定 retry_interval: 15 * 60 // リトライ間隔を設定 }, // jobの設定 - リトライ => 15分で2回リトライ（オプション） params: { arg1: 'test', arg2: 'job' }, // ターゲット関数に渡すパラメータを設定（オプション） }; // 日次cronの詳細を作成 const dailyCron = { cron_name: 'daily_cron', // cronの名前を設定（一意） description: 'daily_cron', // cronの説明を設定（オプション） cron_status: true, // cronのステータスを有効に設定 cron_type: 'Calendar', // cronのタイプをCalendarに設定（日次、月次、年次用） cron_detail: { hour: 0, // cronを実行する時間を設定 minute: 0, // cronを実行する分を設定 second: 0, // cronを実行する秒を設定 repetition_type: 'daily', // 繰り返しタイプをdailyに設定（日次cron用） // timezone: 'America/Los_Angeles' // タイムゾーンを設定する（オプション） }, job_meta: jobMeta // function jobメタデータを設定 }; // 日次cronを作成 const dailyCronDetails = await jobScheduling.CRON.createCron(dailyCron); <br> ### Monthly Cronの作成 以下のSDKを使用して、**月単位の間隔**で固定日時にJob Poolへのジョブ送信をスケジュールするCronを作成できます。さらに、月単位の間隔で特定の週にジョブを送信するオプションもあります。 日付ベースのスケジュールで月単位の間隔でCronを実行するよう設定する場合、**月**に基づく可能な日付の範囲は**1～31**になります。同様に、**週ベース**の間隔を選択する場合、範囲は**1～4**で、特定の**曜日**の範囲は**1～7**になります。 注意: 以下のSDKは、毎月の1日、3日、5日の0時0分0秒にJob Poolにジョブを送信するCronを実行するよう設定されています。cron_detail JSONのキーと値のペアに適切な値を渡すことで、要件に応じてこの値を変更できます。 // function jobメタデータを作成 const jobMeta = { job_name: 'test_job', // jobの名前を設定 target_type: 'Function', // function jobのターゲットタイプをFunctionに設定 target_name: 'target_function', // ターゲット関数の名前を設定（オプション）（target_idまたはtarget_nameは必須） // target_id: '123467890', // ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須） jobpool_name: 'test', // function jobpool名を設定（オプション）（jobpool_nameまたはjobpool_idは必須） // jobpool_id: '1234567890' // 関数ジョブプールのIDを設定する（オプション）（jobpool_nameまたはjobpool_idは必須） job_config: { number_of_retries: 2, // リトライ回数を設定 retry_interval: 15 * 60 // リトライ間隔を設定 }, // jobの設定 - リトライ => 15分で2回リトライ（オプション） params: { arg1: 'test', arg2: 'job' }, // ターゲット関数に渡すパラメータを設定（オプション） }; // 月次cronの詳細を作成 const monthlyCron = { cron_name: 'monthly_cron', // cronの名前を設定（一意） description: 'monthly_cron', // cronの説明を設定（オプション） cron_status: true, // cronのステータスを有効に設定 cron_type: 'Calendar', // cronのタイプをCalendarに設定（日次、月次、年次用） cron_detail: { hour: 0, // cronを実行する時間を設定 minute: 0, // cronを実行する分を設定 second: 0, // cronを実行する秒を設定 days: [1, 3, 5], // cronを実行する月の日を設定 // week_day: [1, 3], // cronを実行する月の曜日を設定する // weeks_of_month: [2], // cronを実行する月の週を設定する repetition_type: 'monthly', // 繰り返しタイプをmonthlyに設定（月次cron用） // timezone: 'America/Los_Angeles' // タイムゾーンを設定する（オプション） }, job_meta: jobMeta // function jobメタデータを設定 }; // 月次cronを作成 const monthlyCronDetails = await jobScheduling.CRON.createCron(monthlyCron); <br> ### Yearly Cronの作成 以下のSDKを使用して、**年単位**の間隔で固定月の固定日時にJob Poolへのジョブ送信をスケジュールするCronを作成できます。さらに、年単位の間隔で特定の週にジョブを送信するオプションもあります。 **年単位**の間隔で**日付ベース**のスケジュールでCronを実行するよう設定する場合、**月**に基づく可能な日付の範囲は**1～31**で、**月**は**1～12**の値の範囲に基づいて決定されます。同様に、**週ベース**の間隔を選択する場合、範囲は**1～4**で、特定の**曜日**の範囲は**1～7**になります。 注意: 以下のSDKは、毎年の8月の1日、2日、3日にJob Poolにジョブを送信するCronを実行するよう設定されています。cron_detail JSONのキーと値のペアに適切な値を渡すことで、要件に応じてこの値を変更できます。 // function jobメタデータを作成 const jobMeta = { job_name: 'test_job', // jobの名前を設定 target_type: 'Function', // function jobのターゲットタイプをFunctionに設定 target_name: 'target_function', // ターゲット関数の名前を設定（オプション）（target_idまたはtarget_nameは必須） // target_id: '123467890', // ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須） jobpool_name: 'test', // function jobpool名を設定（オプション）（jobpool_nameまたはjobpool_idは必須） // jobpool_id: '1234567890' // 関数ジョブプールのIDを設定する（オプション）（jobpool_nameまたはjobpool_idは必須） job_config: { number_of_retries: 2, // リトライ回数を設定 retry_interval: 15 * 60 // リトライ間隔を設定 }, // jobの設定 - リトライ => 15分で2回リトライ（オプション） params: { arg1: 'test', arg2: 'job' }, // ターゲット関数に渡すパラメータを設定（オプション） }; // 年次cronの詳細を作成 const yearlyCron = { cron_name: 'yearly_cron', // cronの名前を設定（一意） description: 'yearly_cron', // cronの説明を設定（オプション） cron_status: true, // cronのステータスを有効に設定 cron_type: 'Calendar', // cronのタイプをCalendarに設定（日次、月次、年次用） cron_detail: { hour: 0, // cronを実行する時間を設定 minute: 0, // cronを実行する分を設定 second: 0, // cronを実行する秒を設定 days: [1, 2, 3], // cronを実行する月の日を設定 // week_day: [1, 3], // cronを実行する月の曜日を設定する // weeks_of_month: [2], // cronを実行する月の週を設定する months: [8], // cronを実行する月を設定 repetition_type: 'yearly', // 繰り返しタイプをyearlyに設定（年次cron用） // timezone: 'America/Los_Angeles' // タイムゾーンを設定する（オプション） }, job_meta: jobMeta // function jobメタデータを設定 }; // 年次cronを作成 const yearlyCronDetails = await jobScheduling.CRON.createCron(yearlyCron); 注意: このSDKは、Dynamic Cronsのみの設定に使用することを推奨します。Pre-defined Cronsの設定にはUI Builderを使用してください。 -------------------------------------------------------------------------------- title: "Cron式を使用したCronの作成" description: "このページでは、サンプルコードスニペットを使用して、プロジェクト内でCron式を使用してCronを作成するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.340Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/cron/create-cron-cron-expressions/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/key-concepts/#cron-expressions) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/create-cron-cron-expressions/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/create-cron-cron-expressions/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/create-cron/create-cron-cron-exp/#CreateaCronUsingCronExpressions) -------------------------------------------------------------------------------- # Cron式を使用したCronの作成 このSDKを使用して、Job PoolへのJobの送信をスケジュールするCronを実装できます。ただし、Cronの設定はCron式と呼ばれる正規表現のような式を使用して定義されます。 注意: 以下のSDKでは、Cron式を使用して、毎年の1月の毎週第1日の0時0分0秒にJob Poolにジョブを送信するようCronが設定されています。cron_expression JSONのキーと値のペアに適切な値を渡すことで、要件に応じてこの値を変更できます。 // function jobメタデータを作成 const jobMeta = { job_name: 'test_job', // jobの名前を設定 target_type: 'Function', // function jobのターゲットタイプをFunctionに設定 target_name: 'target_function', // ターゲット関数の名前を設定（オプション）（target_idまたはtarget_nameは必須） // target_id: '123467890', // ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須） jobpool_name: 'test', // function jobpool名を設定（オプション）（jobpool_nameまたはjobpool_idは必須） // jobpool_id: '1234567890' // 関数ジョブプールのIDを設定する（オプション）（jobpool_nameまたはjobpool_idは必須） job_config: { number_of_retries: 2, // リトライ回数を設定 retry_interval: 15 * 60 // リトライ間隔を設定 }, // jobの設定 - リトライ => 15分で2回リトライ（オプション） params: { arg1: 'test', arg2: 'job' }, // ターゲット関数に渡すパラメータを設定（オプション） }; // 式cronの詳細を作成 const expressionCron = { cron_name: 'expression_cron', // cronの名前を設定（一意） description: 'expression_cron', // cronの説明を設定（オプション） cron_status: true, // cronのステータスを有効に設定 cron_type: 'CronExpression', // cronのタイプをCalendarに設定（日次、月次、年次用） cron_expression: '0 0 * 1 1', // cron式を設定 // timezone: 'America/Los_Angeles', // タイムゾーンを設定する（オプション） cron_detail: {}, // cronの詳細を設定 job_meta: jobMeta // function jobメタデータを設定 }; // 式cronを作成 const expressionCronDetails = await jobScheduling.CRON.createCron(expressionCron); 注意: このSDKは、Dynamic Cronsのみの設定に使用することを推奨します。Pre-defined Cronsの設定にはUI Builderを使用してください。 -------------------------------------------------------------------------------- title: "特定のCronの詳細取得" description: "このページでは、サンプルコードスニペットを使用して、プロジェクト内のCronの詳細を取得するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.340Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/cron/get-cron-details/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/get-cron-details/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/get-cron-details/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/get-cron/#GetCronByIdentifier) -------------------------------------------------------------------------------- # 特定のCronの詳細取得 以下のSDKを使用して、特定の**Pre-Defined Cron**または**Dynamic Cron**のすべての利用可能な詳細を取得できます。cron idまたはCronの名前をgetCron() SDKメソッドに渡す必要があります。 const cronDetailsWithName = await jobScheduling.CRON.getCron('test_cron'); // cron名でcronを取得 const cronDetailsWithId = await jobScheduling.CRON.getCron('1234567890'); // cron IDでcronを取得 -------------------------------------------------------------------------------- title: "すべてのCronの詳細取得" description: "このページでは、サンプルコードスニペットを使用して、プロジェクト内のすべてのCronの詳細を取得するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.340Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/cron/get-all-cron-details/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/get-all-cron-details/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/get-all-cron-details/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/get-all-cron/#GetAllCrons) -------------------------------------------------------------------------------- # すべてのCronの詳細取得 以下のSDKを使用すると、getCron() SDKメソッドを使用して、すべてのPre-Defined Cronsに関するすべての利用可能な情報を取得できます。 注意: このメソッドはPre-Defined Cronsの詳細のみを取得します。Dynamic Cronsには対応していません。 const allCrons = await jobScheduling.CRON.getAllCron(); // すべてのcronを取得 -------------------------------------------------------------------------------- title: "Cronの更新" description: "このページでは、サンプルコードスニペットを使用して、プロジェクト内のCronを更新するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.340Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/cron/update-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/update-cron/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/update-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/update-cron/update-one-time-cron/#UpdateaOne-TimeCron) -------------------------------------------------------------------------------- # Cronの更新 以下のSDKを使用して、特定のCronの詳細を更新できます。このSDKを使用して、名前、説明、ターゲットを更新できます。cron idをgetCron()メソッドに渡して必要なCronを選択し、updateCron()メソッドを使用して詳細を更新できます。 注意: このメソッドはPre-Defined CronsとDynamic Cronsの両方の詳細を更新するために使用できます。 const cron = await jobScheduling.CRON.getCron('test_cron'); // cronを取得 cron.cron_name = 'test'; const updatedCronDetailsWithName = await jobScheduling.CRON.updateCron('test_cron', cron); // cron名でcronの詳細を更新 updatedCronDetailsWithName.cron_name = 'test_new'; const updatedCronDetailsWithId = await jobScheduling.CRON.updateCron('1234567890', updatedCronDetailsWithName); // cron IDでcronの詳細を更新 -------------------------------------------------------------------------------- title: "Cronの一時停止" description: "このページでは、サンプルコードスニペットを使用して、プロジェクト内のCronを一時停止するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.340Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/cron/pause-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/job-scheduling/help/jobpool/introduction/) - Python SDK (/ja/job-scheduling/help/jobpool/introduction/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # Cronの一時停止 このSDKメソッドを使用して、Job PoolへのJobの送信を一時的に停止できます。一時停止するCronのcron idまたは名前をpauseCron() SDKメソッドに渡す必要があります。 注意: このメソッドはPre-Defined CronsとDynamic Cronsの両方の詳細を更新するために使用できます。 const pausedCronWithName = await jobScheduling.CRON.pauseCron('test_cron'); // cron名でcronを一時停止 const pausedCronWithId = await jobScheduling.CRON.pauseCron('1234567890'); // cron IDでcronを一時停止 -------------------------------------------------------------------------------- title: "Cronの再開" description: "このページでは、サンプルコードスニペットを使用して、プロジェクト内で一時停止したCronを再開するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.340Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/cron/resume-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/resume-cron/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/resume-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # Cronの再開 このSDKメソッドを使用して、以前一時停止されたCronの操作を再開できます。一時停止したcron idまたは名前をresumeCron() SDKメソッドに渡すことで実行できます。 注意: このメソッドはPre-Defined CronsとDynamic Cronsの両方の詳細を更新するために使用できます。 const resumedCronWithName = await jobScheduling.CRON.resumeCron('test_cron'); // cron名でcronを再開 const resumedCronWithId = await jobScheduling.CRON.resumeCron('1234567890'); // cron IDでcronを再開 -------------------------------------------------------------------------------- title: "Cronの実行" description: "このページでは、サンプルコードスニペットを使用して、プロジェクト内のCronを実行するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.340Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/cron/run-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/run-cron/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/run-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/submit-cron-now/#SubmitCronInstantly) -------------------------------------------------------------------------------- # Cronの実行 このSDKを使用してCronを実行できます。実行されたCronは、関連するJobを直ちにJob Poolに送信します。cron idまたは名前をrunCron() SDKメソッドに渡すことで実行できます。 注意: このメソッドはPre-Defined CronsとDynamic Cronsの両方の詳細を更新するために使用できます。 const jobA = await jobScheduling.CRON.runCron('test_cron'); // cron名でcronを実行 const jobB = await jobScheduling.CRON.runCron('1234567890'); // cron IDでcronを実行 -------------------------------------------------------------------------------- title: "Cronの削除" description: "このページでは、サンプルコードスニペットを使用して、プロジェクト内のCronを削除するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.340Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/cron/delete-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/delete-cron/) - Python SDK (/ja/sdk/python/v1/job-scheduling/cron/delete-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/delete-cron/#DeleteCron) -------------------------------------------------------------------------------- # Cronの削除 このSDKメソッドを使用して、特定のCronを削除できます。cron idまたは名前をdeleteCron() SDKメソッドに渡すことで実行できます。 注意: このメソッドはPre-Defined CronsとDynamic Cronsの両方の詳細を更新するために使用できます。 const deletedCronWithName = await jobScheduling.CRON.deleteCron('test_cron'); // cron名で削除 const deletedCronWithId = await jobScheduling.CRON.deleteCron('1234567890'); // cron IDで削除 ##### Job Pool -------------------------------------------------------------------------------- title: "すべてのJob Poolの詳細取得" description: "このページでは、サンプルコードスニペットを使用して、プロジェクト内のすべてのJob Poolを取得するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.340Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/jobpool/get-all-jobpool/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Java SDK (en/sdk/java/v1/job-scheduling/jobpool/get-all-job-pool/) - Python SDK (/ja/sdk/python/v1/job-scheduling/jobpool/get-all-jobpool/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # すべてのJob Poolの詳細取得 以下のSDKを使用すると、利用可能なすべてのJob Poolに関するすべての詳細を取得できます。 const allJobpools = await jobScheduling.getAllJobpool(); // すべてのjobpoolの詳細を取得 -------------------------------------------------------------------------------- title: "特定のJob Poolの詳細取得" description: "このページでは、サンプルコードスニペットを使用して、プロジェクト内の特定のJob Poolの詳細を取得するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.341Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/jobpool/get-job-pool/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/jobpool/get-job-pool/) - Python SDK (/ja/sdk/python/v1/job-scheduling/jobpool/get-job-pool/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-jobpool/#GetJobPoolbyIdentifier) -------------------------------------------------------------------------------- # 特定のJob Poolの詳細取得 以下のSDKを使用すると、Job Poolの名前またはIDをgetJobpool() SDKメソッドに渡すことで、特定のJob Poolの詳細を取得できます。 const jobpoolWithName = await jobScheduling.getJobpool('test'); // jobpool名で取得 const jobpoolWithId = await jobScheduling.getJobpool('123456789'); // jobpool IDで取得 ##### Jobs -------------------------------------------------------------------------------- title: "Jobの作成" description: "このページでは、サンプルコードスニペットを使用して、プロジェクト内のすべてのJob Poolを取得するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.341Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/jobs/create-job/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/jobs/create-job/) - Python SDK (/ja/sdk/python/v1/job-scheduling/jobs/create-job/) - REST API Collection (/ja/api/code-reference/job-scheduling/job/submit-job/submit-webhook-job/#SubmitWebhookJobByID) -------------------------------------------------------------------------------- # Jobの作成 以下のSDKメソッドを使用して、Job Functions、Webhooks、Circuits、およびApp SailサービスをトリガーするJobを作成・送信できます。JSONのキーと値のペアの形式でオプションの引数を渡すこともできます。 Jobを作成・送信してトリガーするためのSDKスニペット： // function jobを作成 const functionJob = await jobScheduling.JOB.submitJob({ job_name: 'test_job', // jobの名前を設定 jobpool_name: 'test', // jobを送信するFunction jobpool名を設定 target_type: 'Function', // function jobのターゲットタイプをFunctionに設定 target_name: 'target_function', // ターゲット関数の名前を設定（オプション）（target_idまたはtarget_nameは必須） // target_id: '123467890', // ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須） params: { arg1: 'test', arg2: 'job' }, // ターゲット関数に渡すパラメータを設定（オプション） job_config: { number_of_retries: 2, // リトライ回数を設定 retry_interval: 15 * 60 // リトライ間隔を設定 } // jobの設定 - リトライ => 15分で2回リトライ（オプション） }); // circuit jobを作成 const circuitJob = await jobScheduling.JOB.submitJob({ job_name: 'test_job', // jobの名前を設定 jobpool_name: 'test', // jobを送信するCircuit jobpool名を設定 target_type: 'Circuit', // circuit jobのターゲットタイプをCircuitに設定 target_name: 'target_circuit', // ターゲットcircuitの名前を設定（オプション）（target_idまたはtarget_nameは必須） // target_id: '123467890', // ターゲットサーキットのIDを設定する（オプション）（target_idまたはtarget_nameは必須） test_cases: { arg1: "job", arg2: "test" }, // circuitのテストケースを設定 job_config: { number_of_retries: 2, // リトライ回数を設定 retry_interval: 15 * 60 // リトライ間隔を設定 } // jobの設定 - リトライ => 15分で2回リトライ（オプション） }); // webhook jobを作成 const webhookJob = await jobScheduling.JOB.submitJob({ job_name: 'test_job', // jobの名前を設定 jobpool_name: 'test', // jobを送信するWebhook jobpool名を設定 target_type: 'Webhook', // webhook jobのターゲットタイプをWebhookに設定 request_method: 'POST', // webhookリクエストのメソッドを設定 url: 'https://catalyst.zoho.com', // webhookリクエストのURLを設定 params: { arg1: 'test', arg2: 'job' }, // webhookリクエストのクエリパラメータを設定（オプション） headers: { IS_TEST_REQUEST: 'true' }, // webhookリクエストのヘッダーを設定（オプション） request_body: 'test_request', // webhookリクエストのボディを設定（オプション） job_config: { number_of_retries: 2, // リトライ回数を設定 retry_interval: 15 * 60 // リトライ間隔を設定 } // jobの設定 - リトライ => 15分で2回リトライ（オプション） }); // appsail jobを作成 const appsailJob = await jobScheduling.JOB.submitJob({ job_name: 'test_job', // jobの名前を設定 jobpool_name: 'test', // jobを送信するAppSail jobpool名を設定 target_type: 'AppSail', // appsail jobのターゲットタイプをAppSailに設定 target_name: 'target_appsail', // ターゲットappsailの名前を設定（オプション）（target_idまたはtarget_nameは必須） // target_id: '123467890', // ターゲットAppSailのIDを設定する（オプション）（target_idまたはtarget_nameは必須） request_method: 'POST', // appsailリクエストのメソッドを設定 url: '/test', // appsailのURLパスを設定（オプション） params: { arg1: 'test', arg2: 'job' }, // appsailリクエストのクエリパラメータを設定（オプション） headers: { IS_TEST_REQUEST: 'true' }, // appsailリクエストのヘッダーを設定（オプション） request_body: 'test_request', // appsailリクエストのボディを設定（オプション） job_config: { number_of_retries: 2, // リトライ回数を設定 retry_interval: 15 * 60 // リトライ間隔を設定 } // jobの設定 - リトライ => 15分で2回リトライ（オプション） }); -------------------------------------------------------------------------------- title: "Jobの詳細取得" description: "このページでは、サンプルコードスニペットを使用して、Jobの詳細を取得するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.341Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/jobs/get-job/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/job/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/jobs/get-job/) - Python SDK (/ja/sdk/python/v1/job-scheduling/jobs/get-job/) - REST API Collection (/ja/api/code-reference/job-scheduling/job/get-job/#GetJobByID) -------------------------------------------------------------------------------- # Jobの詳細取得 以下のSDKメソッドを使用すると、Job Poolに送信されたJobに関するすべての利用可能な詳細を取得できます。Job IdをgetJob() SDKメソッドに渡す必要があります。 const job = await jobScheduling.JOB.getJob('1234567890'); // job IDでjobの詳細を取得 -------------------------------------------------------------------------------- title: "Jobの削除" description: "このページでは、サンプルコードスニペットを使用して、Jobを削除するNode.jsメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.341Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/job-scheduling/jobs/delete-job/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/jobs/delete-job/) - Python SDK (/ja/sdk/python/v1/job-scheduling/jobs/delete-job/) - REST API Collection (/ja/api/code-reference/job-scheduling/job/delete-job/#DeleteJobbyID) -------------------------------------------------------------------------------- # Jobの削除 以下のSDKメソッドを使用すると、Job Poolで実行中のJobを削除できます。Job IdをdeleteJob() SDKメソッドに渡す必要があります。 const deletedJob = await jobScheduling.JOB.deleteJob('1234567890'); // job IDでjobを削除 #### Pipelines -------------------------------------------------------------------------------- title: "Pipelineインスタンスの取得" description: "このページでは、Pipelineインスタンスを取得し、他のPipeline操作に使用するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.341Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/pipelines/get-pipeline-instance/" service: "All Services" related: - Catalyst Pipelines (/ja/pipelines/help/pipelines/introduction) - Create a Pipeline (/ja/pipelines/help/pipelines/create-a-pipeline) - Java SDK (/ja/sdk/java/v1/pipelines/get-pipeline-instance) - Python SDK (/ja/sdk/python/v1/pipelines/get-pipeline-instance) - REST API (/ja/api/code-reference/pipelines/get-pipeline-details) -------------------------------------------------------------------------------- # Catalyst Pipelines Catalyst Pipelinesは、Webまたはモバイルアプリケーションのビルド、テスト、デプロイの自動化を可能にするCI/CDアプローチを実装しています。 Catalystコンソールからパイプラインを作成できます。以下のSDKを使用して、Catalyst Pipelineの詳細を取得したり、コードスニペットをアプリケーションに組み込んでパイプラインを実行したりできます。 # Pipelineインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに固有のプロパティにアクセスするために使用できるオブジェクトです。コンポーネントインスタンスを作成して、Catalyst Pipelinesで以下に一覧表示されたアクションを実行できます。 以下のコードで使用されているapp参照は、SDKの初期化時にレスポンスとして返されるNodeオブジェクトです。以下に示すように、新しいpipelines_serviceインスタンスを作成できます。 const pipelines_service = app.pipeline() このコンポーネントインスタンスは、Node.js SDKのすべてのPipeline操作に使用されます。 -------------------------------------------------------------------------------- title: "Pipelineの詳細取得" description: "このページでは、既存のCatalyst Pipelineのすべての詳細を取得するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.341Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/pipelines/get-pipeline-details/" service: "All Services" related: - Catalyst Pipelines (/ja/pipelines/help/pipelines/introduction) - Create a Pipeline (/ja/pipelines/help/pipelines/create-a-pipeline) - Java SDK (/ja/sdk/java/v1/pipelines/get-pipeline-instance) - Python SDK (/ja/sdk/python/v1/pipelines/get-pipeline-instance) - REST API (/ja/api/code-reference/pipelines/get-pipeline-details) -------------------------------------------------------------------------------- # Pipelineの詳細取得 パイプラインIDをパラメーターとしてgetPipelineDetails()メソッドに渡すことで、Catalyst Pipelineの詳細を取得できます。パイプラインの名前、パイプラインが作成されたCatalystプロジェクトの詳細、パイプラインを作成したユーザーの詳細、作成時刻、および変更が行われた場合はパイプラインを変更したユーザーの詳細、変更時刻、パイプラインのステータス、ランナー仕様などのその他の詳細がこのメソッドのレスポンスとして返されます。 以下で使用されているpipelines_service参照は、このコンポーネントインスタンスページですでに定義されています。 let pipline_details = pipelines_service.getPipelineDetails("16965000000019146") サンプルレスポンスを以下に示します： { "status": "success", "data": { "pipeline_id": "16965000000019146", "name": "test1", "project_details": { "project_name": "Project-Rainfall", "id": "5000000000072", "project_type": "Live" }, "created_by": { "zuid": "20257791", "is_confirmed": false, "email_id": "amelia.burrows@zylker.com", "first_name": "Amelia", "last_name": "Burrows", "user_type": "Admin", "user_id": "5000000000056" }, "created_time": "Mar 19, 2024 11:28 AM", "modified_by": { "zuid": "20257791", "is_confirmed": false, "email_id": "amelia.burrows@zylker.com", "first_name": "Amelia", "last_name": "Burrows", "user_type": "Admin", "user_id": "5000000000056" }, "modified_time": "Mar 19, 2024 11:28 AM", "git_account_id": "", "mask_regex": [ null ], "pipeline_status": "Active", "config_id": 2, "integ_id": 1 } } -------------------------------------------------------------------------------- title: "Pipelineの実行" description: "このページでは、Catalyst Pipelineを手動で実行するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.341Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/pipelines/execute-pipeline/" service: "All Services" related: - Catalyst Pipelines (/ja/pipelines/help/pipelines/introduction) - Create a Pipeline (/ja/pipelines/help/pipelines/create-a-pipeline) - Java SDK (/ja/sdk/java/v1/pipelines/get-pipeline-instance) - Python SDK (/ja/sdk/python/v1/pipelines/get-pipeline-instance) - REST API (/ja/api/code-reference/pipelines/get-pipeline-details) -------------------------------------------------------------------------------- # Pipelineの実行 パイプラインIDとブランチ名をパラメーターとしてrunPipeline()メソッドに渡すことで、Catalystパイプラインの実行を開始できます。また、パイプラインの実行に必要な環境変数をJSONオブジェクトとしてこのメソッドに渡すこともできますが、これは完全に任意です。このメソッドは、パイプラインの実行履歴の詳細をレスポンスとして返します。 以下で使用されているpipelines_service参照は、このコンポーネントインスタンスページですでに定義されています。 let execution_details = pipelines_service.runPipeline("8431000000162051", main,{"EVENT": "push", "URL":"https://www.google.com"}) サンプルレスポンスを以下に示します： { "status": "success", "data": { "history_id": "5000000021007", "pipeline_id": "8431000000162051", "event_time": "Mar 20, 2024 02:02 PM", "event_details": { "BRANCH_NAME": "main", "EVENT": "push", "URL": "https://www.google.com" }, "history_status": "Queued" } } #### QuickML -------------------------------------------------------------------------------- title: "QuickMLエンドポイントの実行" description: "このページでは、サンプルコードスニペットを使用して、NodeJSアプリケーションでQuickMLエンドポイントを実行するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.341Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/quickml/execute-quickml-endpoints/" service: "QuickML" related: - QuickML (/ja/quickml/) - QuickML Pipeline Endpoints (/ja/quickml/help/pipeline-endpoints/) -------------------------------------------------------------------------------- # Catalyst QuickML Catalyst QuickMLは、ノーコードの機械学習パイプラインビルダーサービスであり、事前構築されたMLアルゴリズム、操作、データ前処理技術を多数実装し、データセットに接続してMLモデルを構築・公開できます。データパイプラインとMLパイプラインを公開した後、認証済みエンドポイントを使用して作成したモデルにアクセスできます。 ### QuickMLエンドポイントの実行 以下のコードスニペットを使用すると、公開されたQuickMLエンドポイントに入力データを渡し、MLモデルの処理に基づいて結果を予測できます。出力は、MLパイプラインの作成時に定義されたターゲットカラムの値の予測を返します。 注意: 1. 以下のコードスニペットで結果を予測するコードを実行する前に、Catalystコンソールを使用してプロジェクト内でMLパイプラインとモデルのエンドポイントを設定・公開しておく必要があります。 2. QuickMLは現在、JP、SA、またはCAデータセンターからアクセスするCatalystユーザーには利用できません。 以下に示すようにquickmlコンポーネントインスタンスを作成します。これはサーバーサイドの呼び出しを実行しません。入力データをキーと値のペアとしてモデルのエンドポイントに渡すことができます。以下のendpoint_keyは、プロジェクトで設定されたMLモデル用に公開されたエンドポイントの一意のIDです。エンドポイントキーと入力データが実行のためにpredict()メソッドに渡されます。 // 入力データ const input_data = { // データセットに応じて列名と値を入力する "column_name1": "value1", "column_name2": "value2", "column_name3": "value3" } // QuickMLインスタンスを作成する const quickml = app.quickML(); // predictメソッドを実行する const result = await quickml.predict("{endpoint_key}",input_data); // {endpoint_key}をCatalystコンソールからコピーしたエンドポイントキーに置き換えてください console.log(result); 受信する出力の構文を以下に示します： { 'status': 'success', 'result': ["results....."] } #### SmartBrowz -------------------------------------------------------------------------------- title: "SmartBrowzインスタンスの作成" description: "このページでは、SmartBrowzインスタンスを作成する方法について説明します" last_updated: "2026-06-10T06:04:54.341Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/smartbrowz/create-smartbrowz-instance/" service: "SmartBrowz" related: - SmartBrowz (/ja/smartbrowz/getting-started/introduction/) -------------------------------------------------------------------------------- # Catalyst SmartBrowz Catalyst SmartBrowzコンポーネントを使用すると、ヘッドレスブラウザを制御・管理し、WebページのPDFおよびスクリーンショットの生成、動的コンテンツを含むPDFを生成するためのテンプレートの作成、強力なCatalyst APIを使用したWebからのデータ抽出など、さまざまな操作を実行できます。 ### SmartBrowzインスタンスの作成 コンポーネントインスタンスは、特定のコンポーネントに固有のプロパティにアクセスするために使用できるオブジェクトです。SmartBrowzでヘッドレスアクションを実行するためのコンポーネントインスタンスを作成できます。 以下のように新しいsmartbrowzインスタンスを作成できます: const smartbrowz = app.smartbrowz(); このコンポーネントインスタンスは、Node.js SDKのすべてのSmartBrowz操作で使用されます。 -------------------------------------------------------------------------------- title: "PDFとスクリーンショット" description: "このページでは、PDFおよびスクリーンショットを生成する方法について説明します" last_updated: "2026-06-10T06:04:54.341Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/smartbrowz/generate-pdfnscreenshot/" service: "SmartBrowz" related: - PDF & Screenshot - API (/ja/api/code-reference/smartbrowz/generate-pdfnscreenshoturl/#PDF%26ScreenshotwithHTML%2fURLasInput) -------------------------------------------------------------------------------- # PDF & Screenshot Catalyst SmartBrowzは、コードを通じて好みのビジュアルドキュメントを生成するためのPDF & Screenshotコンポーネントを提供します。以下のコードをコピーしてアプリケーションロジックに貼り付けることで、この機能をアプリケーションに組み込むことができます。 以下のSDKを使用して、HTML、URL、またはテンプレートを入力としてビジュアルドキュメントを生成できます。 ### テンプレートを使用したビジュアルドキュメントの生成 const smartbrowz = app.smartbrowz(); let result = await smartbrowz.generateFromTemplate("2075000000021001", { "pdf_options": { 'display_header_footer': true, 'format': 'A1', 'height': '100', 'width': '100', 'landscape': true, 'page_ranges': '1-2', 'scale': 1.0, 'password': '****123' // コンソールからテンプレートのパスワード設定を有効にした後、パスワードを追加 }, "page_options": { 'css': {'content': 'body { font-size: 12px; }'}, 'javascript_enabled': true, 'viewport': { 'height': 800, 'width': 600 }, 'device': 'Blackberry PlayBook' }, 'navigation_options': { 'timeout': 30000, 'wait_until': 'domcontentloaded' "output_options": { "output_type": "pdf" }, "template_data": {} }); console.log('result::', result); ### HTMLからPDFを生成 const smartbrowz = app.smartbrowz(); let result = await smartbrowz.convertToPdf("<html>HI</html>", { "pdf_options": { 'display_header_footer': true, 'footer_template': '<div style="font-size: 10px; width: 100%; text-align: center; padding: 5px;">Page <span class="pageNumber', 'format': 'A1', 'header_template': '<div style="font-size: 10px; width: 100%; text-align: center; padding: 5px;">Header</div>', 'margin': { 'bottom': '20', 'left': '10', 'right': '10', 'top': '20' }, 'height': '100', 'width': '100', 'landscape': true, 'page_ranges': '1-2', 'scale': 1.0, 'password': 'Siva123' }, "page_options": { 'css': {'content': 'body { font-size: 12px; }'}, 'javascript_enabled': true, 'viewport': { 'height': 800, 'width': 600 }, 'device': 'Blackberry PlayBook' }, 'navigation_options': { 'timeout': 30000, 'wait_until': 'domcontentloaded' } }); console.log('result::', result); ### URLからスクリーンショットを生成 const smartbrowz = app.smartbrowz(); let result = await smartbrowz.convertToPdf("https://www.google.com", { "pdf_options": { 'display_header_footer': true, 'footer_template': '<div style="font-size: 10px; width: 100%; text-align: center; padding: 5px;">Page <span class="pageNumber', 'format': 'A1', 'header_template': '<div style="font-size: 10px; width: 100%; text-align: center; padding: 5px;">Header</div>', 'margin': { 'bottom': '20', 'left': '10', 'right': '10', 'top': '20' }, 'height': '100', 'width': '100', 'landscape': true, 'page_ranges': '1-2', 'scale': 1.0, 'password': 'Siva123' }, "page_options": { 'css': {'content': 'body { font-size: 12px; }'}, 'javascript_enabled': true, 'viewport': { 'height': 800, 'width': 600 }, 'device': 'Blackberry PlayBook' }, 'navigation_options': { 'timeout': 30000, 'wait_until': 'domcontentloaded' } }); console.log('result::', result); コンソールのPDF & Screenshotセクションでは、Playground機能を使用してこのコンポーネントを直接テストでき、コンソールから直接SDKをコピーすることもできます。 注意: Browser Logic関数を使用してコーディングするブラウザアクションまたは操作、またはCatalyst SmartBrowzのいずれかのコンポーネントを使用して実行するブラウザ自動化またはWebスクレイピングタスクは、すべてお客様自身の責任で行われます。SmartBrowzコンポーネントは、アクションを許可するドメインで、または適切な承認を得た上で操作を実行するために使用することを強くお勧めします。また、Catalystはファンクションをコーディングするための安全なインフラストラクチャを提供しますが、Catalystファンクションを使用してコーディングしたロジックの結果については、お客様のみが責任を負います。 -------------------------------------------------------------------------------- title: "Dataverse" description: "このページでは、Catalyst DataverseモジュールのSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.342Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/smartbrowz/dataverse/" service: "SmartBrowz" related: - Dataverse (/ja/smartbrowz/help/dataverse/introduction/) -------------------------------------------------------------------------------- # Dataverse Dataverseは、スクレイピングを通じてWebからデータを抽出するCatalyst SmartBrowzのコンポーネントです。Dataverseが提供する3つのカテゴリのデータ抽出機能について以下で説明します。 注意: Web上で公開されている情報のみを提供することを保証します。 ### Lead Enrichment Lead Enrichmentモジュールでは、Webから特定の組織の詳細を取得できます。情報を取得するには、組織名、メールアドレス、またはWebサイトのURLをgetEnrichedLead()メソッドのパラメータとして提供する必要があります。 注意: getEnrichedLead()メソッドには、少なくとも1つのキーの値を提供する必要があります。 ここで使用されているsmartbrowzリファレンスは、前のステップで作成したコンポーネントインスタンスです。 const response = await smartbrowz.getEnrichedLead({ 'leadName':'zoho', 'websiteUrl':'https://www.zoho.com', 'email':'sales@zohocorp.com' }); console.log(response); レスポンスは以下の通りです: [{ "employee_count": "12000", "website": "https://www.zoho.com", "address": [ { "country": "India", "pincode": "603202", "city": "Chengalpattu District", "street": "Estancia It Park, Plot No. 140 151, Gst Road Vallancheri", "state": "Tamil Nadu", "id": "Estancia IT Park, Plot no. 140, 151, GST Road, Vallancheri, Chennai." } ], "social": { "twitter": [ "twitter.com/zoho" ] }, "source_language": "en", "description": "Zoho Corporation offers web-based business applications.", "organization_name": "ZOHO", "ceo": "Sridhar Vembu", "headquarters": [ { "country": "India" } ], "revenue": "$1B", "years_in_industry": "27", "about_us": "https://www.zoho.com/aboutus.html?ireft=nhome&src=home1", "founding_year": "1996", "contact": [ "844-316-5544", "0800-085-6099" ], "industries": { "computer programming services": "Includes data processing services and other computer related services." }, "logo": "https://www.zohowebstatic.com/sites/zweb/images/ogimage/zoho-logo.png", "organization_type": [ "Private Limited Company" ], "business_model": [ "B2B" ], "email": [ "sales@zohocorp.com", "press@zohocorp.com" ], "organization_status": "LARGE_ENTERPRISE", "territory": [ "India", "United States of America" ], "sign_up_link": "https://www.zoho.com/signup.html?all_prod_page=true" } ] ### Tech Stack Finder TechStack Finderモジュールでは、組織が実装している技術や使用しているフレームワークの詳細を取得できます。情報を取得するには、組織のWebサイトURLをfindTechStack()メソッドのパラメータとして提供する必要があります。 ここで使用されているsmartbrowzリファレンスは、前のステップで作成したコンポーネントインスタンスです。 const response = await smartbrowz.findTechStack('https://www.zoho.com'); console.log(response); レスポンスは以下の通りです: [ { "website": "https://www.zoho.com", "technographic_data": { "audio-video media": "Vimeo,YouTube", "ssl_certificate": "Sectigo Limited", "email hosting providers": "Zoho Mail,SPF" }, "organization_name": "ZOHO" } ] ### Similar Companies Similar Companiesモジュールでは、入力として指定した組織と同じまたは類似のサービスを提供する可能性のある組織のリストを取得できます。入力組織の名前またはWebサイトURLをgetSimilarCompanies()メソッドのパラメータとして提供できます。 ここで使用されているsmartbrowzリファレンスは、前のステップで作成したコンポーネントインスタンスです。 const response = await smartbrowz.getSimilarCompanies({ 'leadName':'zoho', 'websiteUrl':'https://www.zoho.com' }); console.log(response); [ "Cybage Software Pvt. Ltd.", "Google LLC", "Chargebee, Inc.", "Infosys Ltd.", 'GlobalLogic Inc.', 'Persistent Systems Ltd.', 'DELTA ELECTRONICS Inc.', 'Salesforce, Inc.' ] 注意: Browser Logic関数を使用してコーディングするブラウザアクションまたは操作、またはCatalyst SmartBrowzのいずれかのコンポーネントを使用して実行するブラウザ自動化またはWebスクレイピングタスクは、すべてお客様自身の責任で行われます。SmartBrowzコンポーネントは、アクションを許可するドメインで、または適切な承認を得た上で操作を実行するために使用することを強くお勧めします。また、Catalystはファンクションをコーディングするための安全なインフラストラクチャを提供しますが、Catalystファンクションを使用してコーディングしたロジックの結果については、お客様のみが責任を負います。 ##### Browser Grid -------------------------------------------------------------------------------- title: "概要" description: "このページでは、Browser Grid操作を実行するために使用できるSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.342Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/smartbrowz/browser-grid/overview/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Java SDK (/ja/sdk/java/v1/smartbrowz/browser-grid/overview/) - Python SDK (/ja/sdk/python/v1/smartbrowz/browser-grid/overview/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # 概要 Browser Gridは、*Catalyst SmartBrowz*サービスのオートスケーリングコンポーネントで、複数のヘッドレスブラウザを設定および管理できます。プロセスに必要なノード数とブラウザ数を設定することで、必要なグリッドを構成するオプションが提供されます。 Browser Grid Node.js SDKを使用すると、ブラウザグリッドの詳細の取得、ブラウザグリッドのノード詳細の取得、およびブラウザグリッドの実行の終了が可能になります。 ### SDKメソッド一覧 <table class="content-table"> <thead> <tr> <th class="w25p">カテゴリ</th> <th class="w50p">SDKメソッド</th> <th class="w25p">スコープ要件</th> </tr> </thead> <tbody> <tr> <td>一般操作</td> <td>Browser Gridインスタンスの取得</td> <td>Admin</td> </tr> <tr> <td>Browser Grid操作</td> <td> <ul> <li>すべてのブラウザグリッドの取得</li> <li>特定のブラウザグリッドの取得</li> <ul> <li>IDを使用した特定のブラウザグリッドの取得</li> <li>名前を使用した特定のブラウザグリッドの取得</li> </ul> <li>グリッドのノードの取得</li> <ul> <li>Grid IDを使用</li> <li>グリッド名を使用</li> </ul> <li>ブラウザグリッドの停止</li> <ul> <li>Grid IDを使用</li> <li>グリッド名を使用</li> </ul> </ul> </td> <td>Admin</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "Browser Gridインスタンスの取得" description: "このページでは、Browser Grid操作を実行するために使用できるSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.342Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/smartbrowz/browser-grid/get-instance/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Java SDK (/ja/sdk/java/v1/smartbrowz/browser-grid/get-instance/) - Python SDK (/ja/sdk/python/v1/smartbrowz/browser-grid/get-instance/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # Browser Gridインスタンスの取得 以下のようにブラウザグリッドインスタンスを取得できます。これはサーバーサイドの呼び出しを発行しません。Browser Gridコンポーネントを操作する際のさまざまなコードスニペットで、このコンポーネントインスタンスを参照します。 const grid = app.SmartBrowz().browserGrid(); // Browser Gridインスタンスを取得 -------------------------------------------------------------------------------- title: "すべてのBrowser Grid詳細の取得" description: "このページでは、Browser Grid操作を実行するために使用できるSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.342Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/smartbrowz/browser-grid/get-all-grids/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Java SDK (/ja/sdk/java/v1/smartbrowz/browser-grid/get-all-grids/) - Python SDK (/ja/sdk/python/v1/smartbrowz/browser-grid/get-all-grids/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # すべてのBrowser Grid詳細の取得 getGrid() SDKメソッドを使用して、プロジェクトに存在するすべてのブラウザグリッドのグリッド詳細を取得できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 情報: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションを参照してください。 const gridList = await grid.getGrid(); // すべてのグリッドの詳細を返す console.log(gridList); ### 期待されるレスポンスの例 { "status": "success", "data": [ { "id": "3970000000006058", "name": "play", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 07:04 PM", "modified_time": "Sep 10, 2025 07:04 PM", "api_key_modified_time": "1757511270919", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 1, "max_session_count": 1, "max_nodes_count": 10, "max_concurrent_count": 10, "config_type": 1 }, { "id": "3970000000005426", "name": "Automation", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 12:47 PM", "modified_time": "Sep 23, 2025 03:12 PM", "api_key_modified_time": "1757488669690", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 2, "max_session_count": 1, "max_nodes_count": 5, "max_concurrent_count": 5, "config_type": 2 }, { "id": "3970000000005027", "name": "SDK", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 11:33 AM", "modified_time": "Sep 10, 2025 04:27 PM", "api_key_modified_time": "1757484201284", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 2, "max_session_count": 1, "max_nodes_count": 5, "max_concurrent_count": 5, "config_type": 1 }, { "id": "3970000000005015", "name": "Puppeteer_Grid", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 10:21 AM", "modified_time": "Sep 10, 2025 10:21 AM", "api_key_modified_time": "1757479864798", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 1, "max_session_count": 1, "max_nodes_count": 1, "max_concurrent_count": 1, "config_type": 1 }, { "id": "3970000000005013", "name": "Selenium_Gridt", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 10:21 AM", "modified_time": "Sep 23, 2025 05:50 PM", "api_key_modified_time": "1757479864794", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 2, "max_session_count": 1, "max_nodes_count": 1, "max_concurrent_count": 1, "config_type": 2 } ] } -------------------------------------------------------------------------------- title: "特定のBrowser Gridの取得" description: "このページでは、Browser Grid操作を実行するために使用できるSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.342Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/smartbrowz/browser-grid/get-specific-grid/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Java SDK (/ja/sdk/java/v1/smartbrowz/browser-grid/get-specific-grid/) - Python SDK (/ja/sdk/python/v1/smartbrowz/browser-grid/get-specific-grid) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # 特定のBrowser Gridの取得 Grid IDまたはグリッド名をgetGrid() SDKメソッドに渡すことで、プロジェクト内の特定のブラウザグリッドの詳細を取得できます。 情報: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションを参照してください。 ### Grid IDを使用 必要なブラウザグリッドの**Grid ID**をgetGrid() SDKメソッドに渡すことができます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 const gridDetails = await grid.getGrid("3970000000005013"); // Grid IDを使用してグリッドの詳細を取得 console.log(gridDetails); ### グリッド名を使用 必要なブラウザグリッドの名前をgetGrid() SDKメソッドに渡すことができます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 const gridDetails = await grid.getGrid("Selenium_Grid"); // グリッド名を使用してグリッドの詳細を取得 console.log(gridDetails); ### 期待されるレスポンスの例 { "status": "success", "data": { "id": "3970000000006058", "name": "Selenium_Grid", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 07:04 PM", "modified_time": "Sep 24, 2025 11:55 AM", "api_key_modified_time": "1757511270919", "created_by": { "zuid": "111734674", "is_confirmed": false, "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "is_confirmed": false, "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 1, "max_session_count": 1, "max_nodes_count": 10, "max_concurrent_count": 10, "config_type": 1 } } -------------------------------------------------------------------------------- title: "ノードの詳細の取得" description: "このページでは、Browser Grid操作を実行するために使用できるSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.342Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/smartbrowz/browser-grid/get-specific-node/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Java SDK (/ja/sdk/java/v1/smartbrowz/browser-grid/get-specific-node/) - Python SDK (/ja/sdk/python/v1/smartbrowz/browser-grid/get-specific-node/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # ノードの詳細の取得 必要なブラウザグリッドの**Grid ID**または名前をgetGridNodes() SDKメソッドに渡すことで、そのグリッドのノードの詳細を取得できます。 情報: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションを参照してください。 ### Grid IDを使用 必要なブラウザグリッドの**Grid ID**をgetGridNodes() SDKメソッドに渡して、ノードの詳細を取得できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 const nodeDetails = await grid.getGridNodes("3970000000005013"); // Grid IDを使用してノードの詳細を取得 ### グリッド名を使用 必要なブラウザグリッドの名前をgetGridNodes() SDKメソッドに渡して、ノードの詳細を取得できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 const nodeDetails = await grid.getGridNodes("Selenium_Grid"); // グリッド名を使用してノードの詳細を取得 -------------------------------------------------------------------------------- title: "Browser Gridの停止" description: "このページでは、Browser Grid操作を実行するために使用できるSDKメソッドの概要を説明します。" last_updated: "2026-06-10T06:04:54.342Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/smartbrowz/browser-grid/stop-grid/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Java SDK (/ja/sdk/java/v1/smartbrowz/browser-grid/stop-grid/) - Python SDK (/ja/sdk/python/v1/smartbrowz/browser-grid/stop-grid/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # Browser Gridの停止 必要なブラウザグリッドの**Grid ID**または名前をstopGrid() SDKメソッドに渡すことで、すべての実行を終了し、ブラウザグリッドを停止できます。 情報: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、このセクションを参照してください。 ### Grid IDを使用 必要なブラウザグリッドの**Grid ID**をstopGrid() SDKメソッドに渡して、グリッドを停止し、すべての実行を終了できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 const gridTerminate = await grid.stopGrid("3970000000005013"); // Grid IDを使用してグリッドを停止 ### グリッド名を使用 必要なブラウザグリッドの名前をstopGrid() SDKメソッドに渡して、グリッドを停止し、すべての実行を終了できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 const gridTerminate = await grid.stopGrid("Selenium_Grid"); // グリッド名を使用してグリッドを停止 ### 期待されるレスポンスの例 { "status": "success", "data": true } #### Zia Services -------------------------------------------------------------------------------- title: "Ziaインスタンスの取得" description: "このページでは、Node.jsアプリケーションでBarcode Scanner機能を使用してデータ形式をスキャンする方法について、サンプルコードスニペットとともに説明します" last_updated: "2026-06-10T06:04:54.343Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/get-component-instance/" service: "Zia Services" -------------------------------------------------------------------------------- ### コンポーネントインスタンスの取得 ziaリファレンスは、以下の方法で作成できます。これはサーバーサイドの呼び出しを発行しません。 //Get a zia instance let zia = app.zia(); -------------------------------------------------------------------------------- title: "OCR" description: "このページでは、Node.jsアプリケーションで光学文字認識機能を使用してテキスト文字を検出する方法について、サンプルコードスニペットとともに説明します" last_updated: "2026-06-10T06:04:54.343Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/ocr/" service: "Zia Services" related: - OCR - API (/ja/api/code-reference/zia-services/ocr/#OCR) -------------------------------------------------------------------------------- # Optical Character Recognition Zia Optical Character Recognitionは、画像やデジタルドキュメント内のテキスト文字を電子的に検出し、機械エンコードされたテキストに変換します。Zia OCRは、9つの国際言語と10のインド言語のテキストを認識できます。APIドキュメントから言語と言語コードのリストを確認できます。 注意:Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたファイルは一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystのコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。 OCR処理が必要な画像またはドキュメントファイルへのパスを指定する必要があります。レスポンスには、認識されたテキストに加えて、処理の精度を定義する信頼度スコアも含まれます。 許可されるファイル形式: ._jpg_、._jpeg_、._png_、._tiff_、._bmp_、._pdf_ ファイルサイズ制限: 20 MB ファイルパス、モデルタイプ、および言語をextractOpticalCharacters()メソッドの引数として渡す必要があります。ただし、モデルタイプと言語の値はオプションです。デフォルトでは、OCRモデルタイプとして渡され、言語は指定されない場合自動的に検出されます。 以下で使用されているziaリファレンスは、 コンポーネントインスタンスページで定義されています。 ここで返されるPromiseは、JSONオブジェクトに解決されます。 let fs = require('fs'); //Define the file stream for file attachments let result = await zia.extractOpticalCharacters( fs.createReadStream('/Users/amelia-421/Desktop/MyDoc.webp'), { language:'eng', modelType: 'OCR' }) ; console.log(result); 受信するサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 #### Node js { "confidence":95, "text":"This is a lot of 12 point text to test the\nocr code and see if it works on all types\nof file format\n\nThe quick brown dog jumped over the\nlazy fox. The quick brown dog jumped\nover the lazy fox. The quick brown dog\njumped over the lazy fox. The quick\nbrown dog jumped over the lazy fox" } -------------------------------------------------------------------------------- title: "顔分析" description: "このページでは、Node.jsアプリケーションでFace Analytics機能を使用して指定された条件で顔を検出する方法について、サンプルコードスニペットとともに説明します" last_updated: "2026-06-10T06:04:54.343Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/face-analytics/" service: "Zia Services" related: - Face analytics - API (/ja/api/code-reference/zia-services/face-analytics/#FaceAnalytics) -------------------------------------------------------------------------------- # Face Analytics Zia Face Analyticsは、画像内の顔を検出し、顔の特徴を分析して、検出された顔の性別、年齢、感情などの情報を提供します。 入力として._jpg_/._jpeg_または._png_ファイルを提供する必要があります。リクエストとレスポンスの形式については、APIドキュメントを参照してください。 analyseFace()メソッドは、入力画像を引数として受け取ります。また、分析モードをbasic、moderate、またはadvancedとして指定できます。さらに、属性としてage、smile、またはgenderを、検出する場合はtrue、検出しない場合はfalseとして指定できます。 これらの値はオプションです。デフォルトでは、すべての属性が検出され、advancedモードで処理されます。 レスポンスは、有効化された属性の予測結果、各顔の顔の特徴の座標とランドマーク、および各分析の信頼度スコアを返します。 以下で使用されているziaリファレンスは、 コンポーネントインスタンスページで定義されています。 ここで返されるPromiseは、JSONオブジェクトに解決されます。 let fs = require('fs'); var zia = app.zia(); //入力ファイル、モード、検出する特徴を渡す zia.analyseFace(fs.createReadStream('./face.png'), { mode: 'moderate', age: true, emotion: true, gender: false }).then((result) => { console.log(result); }) .catch((err) => console.log(err.toString())); //エラーをCatalyst Logsに記録する 各バージョンで受信するサンプルレスポンスを以下に示します: { "faces_count":1, "faces":[ { "co_ordinates":[ "401", "193", "494", "313" ], "emotion":{ "confidence":{ "smiling":"0.75", "not_smiling":"0.25" }, "prediction":"smiling" }, "gender":{ }, "confidence":1, "id":"0", "landmarks":{ "right_eye":[ [ "467", "230" ] ], "nose":[ [ "451", "264" ] ], "mouth_right":[ [ "474", "278" ] ], "left_eye":[ [ "426", "239" ] ], "mouth_left":[ [ "434", "283" ] ] }, "age":{ "confidence":{ "20-29":"0.73", "30-39":"0.08", "0-2":"0.0", "40-49":"0.0", "50-59":"0.0", ">70":"0.0", "60-69":"0.0", "10-19":"0.17", "3-9":"0.0" }, "prediction":"20-29" } } ] } { "faces_count":1, "faces":[ { "co_ordinates":[ 401, 193, 494, 313 ], "emotion":{ "confidence":{ "smiling":"0.75", "not_smiling":"0.25" }, "prediction":"smiling" }, "gender":{ }, "confidence":1, "id":0, "landmarks":{ "right_eye":[ [ 467, 230 ] ], "nose":[ [ 451, 264 ] ], "mouth_right":[ [ 474, 278 ] ], "left_eye":[ [ 426, 239 ] ], "mouth_left":[ [ 434, 283 ] ] }, "age":{ "confidence":{ "20-29":"0.73", "30-39":"0.08", "0-2":"0.0", "40-49":"0.0", "50-59":"0.0", ">70":"0.0", "60-69":"0.0", "10-19":"0.17", "3-9":"0.0" }, "prediction":"20-29" } } ] } -------------------------------------------------------------------------------- title: "画像モデレーション" description: "このページでは、Node.jsアプリケーションでImage Moderation機能を使用して画像の脆弱性を検出する方法について、サンプルコードスニペットとともに説明します" last_updated: "2026-06-10T06:04:54.343Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/image-moderation/" service: "Zia Services" related: - Image moderation - API (/ja/api/code-reference/zia-services/image-moderation/#ImageModeration) -------------------------------------------------------------------------------- # Image Moderation Image Moderationは、画像内の不適切で安全でないコンテンツを検出し認識します。基準には、示唆的または露骨な際どいコンテンツ、ヌード、暴力、流血、出血、武器や薬物の存在が含まれます。 入力として._jpg_/._jpeg_または._png_ファイルを提供できます。リクエストとレスポンスの形式については、APIドキュメントを参照してください。 モデレーションモードをオプションでBASIC、MODERATE、またはADVANCEDに設定できます。デフォルトでは、画像はADVANCEDモードで処理されます。 レスポンスは、各基準の確率と信頼度スコア、および画像が safe_to_useまたはunsafe_to_useであるという予測を返します。 以下で使用されているziaリファレンスは、コンポーネントインスタンスページで定義されています。ここで返されるPromiseは、JSONオブジェクトに解決されます。 let fs = require('fs'); zia.moderateImage(fs.createReadStream('./weapon.png'), {mode: 'moderate'}) //入力ファイルとモードを渡す .then((result) => { console.log(result); }).catch((err) => console.log(err.toString())); //エラーをCatalyst Logsに記録する 受信するサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 #### Node js {"probability":{"racy":"0.09","nudity":"0.06"},"confidence":"0.85","prediction":"safe_to#_use"} -------------------------------------------------------------------------------- title: "物体認識" description: "このページでは、Node.jsアプリケーションでObject Recognition機能を使用してオブジェクトを検出する方法について、サンプルコードスニペットとともに説明します" last_updated: "2026-06-10T06:04:54.343Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/object-recognition/" service: "Zia Services" related: - Object recognition - API (/ja/api/code-reference/zia-services/object-recognition/#ObjectRecognition) -------------------------------------------------------------------------------- # Object Recognition Object Recognitionは、画像ファイル内の個々のオブジェクトを検出、特定、認識します。Zia Object Recognitionは、画像から80種類のオブジェクトを識別できます。 入力として._jpg_/._jpeg_または._png_ファイルを提供できます。リクエストとレスポンスの形式については、APIドキュメントを参照してください。 detectObject()メソッドは、画像内のオブジェクトを検出して識別するために使用され、入力ファイルがこのメソッドの引数として渡されます。各オブジェクトの座標、種類、および各認識の信頼度スコアが返されます。 以下で使用されているziaリファレンスは、コンポーネントインスタンスページで定義されています。 ここで返されるPromiseは、JSONオブジェクトに解決されます。 let fs = require('fs'); let result = await zia.detectObject(fs.createReadStream('./sampimage.webp')) ; console.log(result); 各バージョンで受信するサンプルレスポンスを以下に示します: { "objects":[ { "co_ordinates":[ "322", "125", "708", "1201" ], "object_type":"person", "confidence":"99.82" } ] } { "objects":[ { "co_ordinates":[ 322, 125, 708, 1201 ], "object_type":"person", "confidence":"99.82" } ] } -------------------------------------------------------------------------------- title: "バーコードスキャナー" description: "このページでは、Node.jsアプリケーションでBarcode Scanner機能を使用して特定のデータ形式をスキャンする方法について、サンプルコードスニペットとともに説明します" last_updated: "2026-06-10T06:04:54.343Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/barcode-scanner/" service: "Zia Services" related: - Barcode scanner - API (/ja/api/code-reference/zia-services/barcode-scanner/#BarcodeScanner) -------------------------------------------------------------------------------- # Barcode Scanner Zia Barcode Scannerを使用すると、最も一般的に使用されるリニアおよび2Dバーコード形式をスキャンし、エンコードされたデータをデコードできます。Barcode Scannerは、Codabar、EAN-13、ITF、UPC-A、QR Codeなどの形式を検出できます。 入力ファイルとして._jpg_/._jpeg_または._png_形式を提供できます。リクエストとレスポンスの形式については、APIドキュメントを参照してください。 setFormatを使用してバーコード形式を指定できます。形式として ALLを入力すると、Barcode Scannerが自動的に形式を検出します。デコードされた情報がレスポンスとして返されます。 以下で使用されているziaリファレンスは、コンポーネントインスタンスページで定義されています。ここで返されるPromiseは、JSONオブジェクトに解決されます。 let fs = require('fs'); zia.scanBarcode(fs.createReadStream('./barcode.png'), {format: 'code39'}) //入力ファイルとフォーマットを渡す .then((result) => { console.log(result); }) .catch((err) => console.log(err.toString())); //エラーをCatalyst Logsに記録する 受信するサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 #### Node js { "content": "https://demo.dynamsoft.com/dbr_wasm/barcode_reader_javascript.html" } ##### ID スキャナー -------------------------------------------------------------------------------- title: "顔の比較" description: "このページでは、Node.jsアプリケーションで顔比較機能を使用する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.343Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/identity-scanner/facial-comparison/" service: "Zia Services" related: - Facial comparison - API (/ja/api/code-reference/zia-services/identity-scanner/facial-comparison/#FacialComparison) - Identity Scanner (/ja/zia-services/help/identity-scanner/introduction) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、Zia AI駆動のコンポーネントで、さまざまなIDプルーフや公式書類をスキャンして処理することで、個人やドキュメントに対する安全な本人確認を実行できます。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注意: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystのコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。 ### Facial Comparison Facial Comparison（E-KYCとも呼ばれます）は、Identity Scannerの一部で、2つの異なる画像に含まれる2つの顔を比較して、同一人物かどうかを判定します。これにより、IDプルーフと既存の写真を比較することで、個人の身元を確認できます。たとえば、個人のAadhaarカードなどの写真付きIDの信頼性を、現在の写真と比較して確認できます。 注意: Identity ScannerのDocument Processing機能はインドのユーザーにのみ関連しますが、Facial ComparisonのAPIおよびSDKツールはグローバルに利用可能です。ただし、CatalystコンソールからのFacial ComparisonまたはE-KYCのアクセスとテストは、IN DCのユーザーのみに制限されています。 サンプルコードに示すように、ソース画像とクエリ画像の両方の画像ファイルへのパスを指定して、顔比較を実行できます。compareFace()メソッドがこれらの両方の画像を処理します。ここで使用されているziaリファレンスは、コンポーネントインスタンスページで定義されています。 注意: IDプルーフの画像または個人の写真のいずれかをソースまたはクエリ画像として指定できます。これは結果に影響しません。 許可されるファイル形式: _.webp_、_.jpeg_、_.png_ ファイルサイズ制限: 10 MB 比較結果は、顔が一致する場合はtrueに、一致しない場合はfalseに設定されます。結果には、処理の精度を判定する0から1の範囲の信頼度スコアも含まれます。比較の信頼度スコアが50%（0.5）を超えた場合のみ、結果がtrueに設定されます。 let fs = require('fs'); const zia = app.zia(); const sourceImage = fs.createReadStream('/Users/amelia-421/Desktop/source.webp'); //ファイルパスを指定する const queryImage = fs.createReadStream('/Users/amelia-421/Desktop/query.webp'); //ファイルパスを指定する zia.compareFace(sourceImage, queryImage) .then((res) => console.log(res)) .catch((err) => console.log('error: ', err)); //エラーをCatalyst Logsに記録する 受信するサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 #### Node js { confidence: 0.9464, matched: "true" } -------------------------------------------------------------------------------- title: "Aadhaar" description: "このページでは、Node.jsアプリケーションでAADHAARドキュメント処理機能を使用する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.343Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/identity-scanner/aadhaar/" service: "Zia Services" related: - Identity Scanner (/ja/zia-services/help/identity-scanner/introduction) - Aadhaar - API (/ja/api/code-reference/zia-services/identity-scanner/aadhaar/#Aadhaar) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、Zia AI駆動のコンポーネントで、さまざまなIDプルーフや公式書類をスキャンして処理することで、個人やドキュメントに対する安全な本人確認を実行できます。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注意: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystのコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。 ### Aadhaar AADHAARモデルは、Document Processing機能の一部で、インドのAadhaarカードを本人確認書類として処理できます。高度なOCR技術を使用して、インドのAadhaarカードからデータフィールドを抽出できます。レスポンスは、Aadhaarカードから認識されたパラメータと、各認識の精度を判定する信頼度スコアを返します。 注意:Document Processingはインドのユーザーにのみ関連し、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SA、またはCAデータセンターからアクセスするユーザーには利用できません。他のDCからのインド国外のユーザーは、汎用OCRコンポーネントにアクセスしてテキストコンテンツを読み取り、処理できます。 以下のコードに示すように、createReadStreamを通じてAadhaarカードの表面と裏面の画像ファイルへのパスを提供する必要があります。以下で使用されているziaリファレンスは、コンポーネントインスタンスページで定義されています。ここで返されるPromiseは、JSONオブジェクトに解決されます。 注意: Aadhaarカードに含まれる言語を渡すオプションは廃止されました。Identity Scannerは、Aadhaarカードの言語を自動的に識別して処理するようになりました。Node.js SDKのコードスニペットはまもなく更新される予定です。 以下のコードに示すように、一時的に言語を渡すことができます。英語と関連する地域言語を渡す必要があります。たとえば、タミル・ナードゥ州出身の場合、tamとengを言語として渡す必要があります。言語と言語コードのリストは、APIドキュメントから確認できます。 許可されるファイル形式: _.webp_、_.jpeg_、_.png_、_.bmp_、_.tiff_、_.pdf_<br /> ファイルサイズ制限: 15 MB レスポンスには、カード所有者の名前、住所、性別、Aadhaarカード番号など、Aadhaarカードで認識されたパラメータがそれぞれのキーに割り当てられて含まれます。レスポンスには、認識された各値に対して0から1の範囲の信頼度スコアも表示されます。 let fs = require('fs'); var zia = app.zia(); zia.extractAadhaarCharacters(fs.createReadStream('./frontImg.webp'), fs.createReadStream('./backImg.webp'),'eng,tam') //Pass the input files with the languages .then((result) => { console.log(result); }) .catch((err) => console.log(err.toString())); }); //エラーをCatalyst Logsに記録する 受信するサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 #### Nodejs { text: "{ "address":{ "prob":0.5,"value":"C/O Rainbow, xxxx STREET, xxxx- 0000" }, "gender":{ "prob":0.8,"value":"MALE" }, "dob":{ "prob":0.8, "value":"08/09/2001" }, "name":{ "prob":0.6, "value":"Ram Singh" }, "aadhaar":{ "prob":0.8, "value":"4000 0000 0000" } }" } -------------------------------------------------------------------------------- title: "PAN" description: "このページでは、Node.jsアプリケーションでPANドキュメント処理機能を使用する方法について、サンプルコードスニペットとともに説明します" last_updated: "2026-06-10T06:04:54.343Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/identity-scanner/pan/" service: "Zia Services" related: - Identity Scanner (/ja/zia-services/help/identity-scanner/introduction) - PAN - API (/ja/api/code-reference/zia-services/identity-scanner/pan/#PAN) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、Zia AI駆動のコンポーネントで、さまざまなIDプルーフや公式書類をスキャンして処理することで、個人やドキュメントに対する安全な本人確認を実行できます。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注意:Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystのコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。 ### PAN PANモデルは、Document Processing機能の一部で、インドのPANカードを本人確認書類として処理できます。高度なOCR技術を使用してPANカードからデータフィールドを抽出し、レスポンスでPANカードから認識されたパラメータを返します。 注意:Document Processingはインドのユーザーにのみ関連し、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SA、またはCAデータセンターからアクセスするユーザーには利用できません。他のDCからのインド国外のユーザーは、汎用OCRコンポーネントにアクセスしてテキストコンテンツを読み取り、処理できます。 以下のコードに示すように、PANカードの表面の画像ファイルへのパスを提供する必要があります。以下で使用されているziaリファレンスは、コンポーネントインスタンスページで定義されています。 許可されるファイル形式: _.webp_、_.jpeg_、_.png_<br /> ファイルサイズ制限: 15 MB modelTypeを使用してモデルタイプをPANとして指定する必要があります。PANモデルはデフォルトで英語のテキストのみを処理できます。他の言語はサポートされていません。 レスポンスには、名、姓、生年月日、PANカード番号など、PANカードから抽出されたパラメータがそれぞれのキーに割り当てられて含まれます。 let fs = require('fs'); const zia = app.zia(); zia.extractOpticalCharacters(fs.createReadStream('/Users/amelia-421/Desktop/pan.webp'), {modelType: 'PAN'}) //Pass the input file with the model type .then((result) => { console.log(result); }) .catch((err) => console.log(err.toString())); //エラーをCatalyst Logsに記録する }); 受信するサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 #### Nodejs { date_of_birth: "03/04/1982", last_name: "VASUDEV MAHTO", pan: "ANRPM2537J", first_name: "PRAMOD KUMAR MAHTO" } -------------------------------------------------------------------------------- title: "通帳" description: "このページでは、アプリケーションでPASSBOOKドキュメント処理機能を使用する方法について、サンプルコードスニペットとともに説明します" last_updated: "2026-06-10T06:04:54.343Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/identity-scanner/passbook/" service: "Zia Services" related: - Identity Scanner (/ja/zia-services/help/identity-scanner/introduction) - Passbook - API (/ja/api/code-reference/zia-services/identity-scanner/passbook/#Passbook) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、Zia AI駆動のコンポーネントで、さまざまなIDプルーフや公式書類をスキャンして処理することで、個人やドキュメントに対する安全な本人確認を実行できます。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注意: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystのコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。 ### Passbook PASSBOOKモデルは、Document Processing機能の一部で、インドの銀行通帳を金融書類または本人確認書類として処理できます。OCR技術を使用して通帳からデータフィールドを抽出し、レスポンスでパラメータを取得できます。 注意: Document Processingはインドのユーザーにのみ関連し、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SA、またはCAデータセンターからアクセスするユーザーには利用できません。他のDCからのインド国外のユーザーは、汎用OCRコンポーネントにアクセスしてテキストコンテンツを読み取り、処理できます。 Passbookモデルは、11のインド言語と追加の8つの国際言語をサポートしています。言語と言語コードのリストは、APIドキュメントから確認できます。 以下のコードに示すように、通帳の表面ページの画像へのパスを提供する必要があります。 許可されるファイル形式: _.webp_、_.jpeg_、_.png_、_.bmp_、_.tiff_、_.pdf_<br /> ファイルサイズ制限: 15 MB キーmodelTypeを使用してモデルタイプをPASSBOOKとして指定する必要があります。 以下のコードに示すように、オプションで言語を指定することもできます。指定しない場合、デフォルト言語として英語が使用されます。 レスポンスには、銀行名、支店、住所、口座番号など、通帳から認識された銀行詳細と口座詳細がそれぞれのキーに割り当てられて含まれます。レスポンスには、その口座でRTGS、NEFT、IMPSが有効になっているかどうかも表示されます。 注意: Identity Scannerは、通帳に含まれる言語に関係なく、レスポンスを英語でのみ返します。 以下で使用されているziaリファレンスは、コンポーネントインスタンスページで定義されています。 let fs = require('fs'); var zia = app.zia(); zia.extractOpticalCharacters(fs.createReadStream('/Users/amelia-421/Desktop/passbook.webp'), {language: 'tam', modelType: 'PASSBOOK'}) //モデルタイプとオプションの言語で入力ファイルを渡す .then((result) => { console.log(result); }) .catch((err) => console.log(err.toString())); //エラーをCatalyst Logsに記録する }); 受信するサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 #### Node js { text: "{ "address":"No.20,Gandhi Road,M.G Lane", "city":"Chennai", "centre":"Chennai", "bankName":"ABX BANK LIMITED", "accountNumber":"002001001625859", "branch":"Anna Nagar", "dateOfOpening":"30/08/2012", "imps":"true", "neft":"true", "district":"Chennai", "contact":"801234567", "micr":"641021121", "name":" 2312312", "state":"Tamil Nadu", "rtgs":"true", "ifsc":"ABX0000311" }" } -------------------------------------------------------------------------------- title: "小切手" description: "このページでは、Node.jsアプリケーションでChequeドキュメント処理機能を使用する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.344Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/identity-scanner/cheque/" service: "Zia Services" related: - Identity Scanner (/ja/zia-services/help/identity-scanner/introduction) - Cheque - API (/ja/api/code-reference/zia-services/identity-scanner/cheque/#Cheque) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、Zia AI駆動のコンポーネントで、さまざまなIDプルーフや公式書類をスキャンして処理することで、個人やドキュメントに対する安全な本人確認を実行できます。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注意: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystのコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。 ### Cheque CHEQUEモデルは、Document Processing機能の一部で、インドの銀行小切手を本人確認書類として処理できます。高度なOCR技術を使用して小切手からデータフィールドを抽出し、レスポンスで小切手から認識されたパラメータを取得できます。 注意: Document Processingはインドのユーザーにのみ関連し、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SA、またはCAデータセンターからアクセスするユーザーには利用できません。他のDCからのインド国外のユーザーは、汎用OCRコンポーネントにアクセスしてテキストコンテンツを読み取り、処理できます。 以下のコードに示すように、小切手帳の表面の画像ファイルへのパスを提供する必要があります。CHEQUEモデルはデフォルトで英語のテキストのみを処理できます。他の言語はサポートされていません。 許可されるファイル形式: _.webp_、_.jpeg_、_.png_<br /> ファイルサイズ制限: 15 MB modelType()を使用してモデルタイプをCHEQUEとして指定する必要があります。 注意:ZiaはCTS-2010形式の小切手のみを処理します。 以下で使用されているziaリファレンスは、コンポーネントインスタンスページで定義されています。 let fs = require('fs'); var zia = app.zia(); zia.extractOpticalCharacters(fs.createReadStream('/Users/amelia-421/Desktop/cheque.webp'), {modelType: 'CHEQUE'}) //Pass the input file with the model type .then((result) => { console.log(result); }) .catch((err) => console.log(err.toString())); //エラーをCatalyst Logsに記録する }); 受信するサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 #### Nodejs { date: "15/11/2014", account_number: "89323223232222", amount: "10615", branch_name: "ANNA NAGAR", bank_name: "ABX BANK", ifsc: "BB9033232" } ##### テキスト解析 -------------------------------------------------------------------------------- title: "感情分析" description: "このページでは、Node.jsアプリケーションで感情分析機能を使用する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.344Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/text-analytics/sentiment-analysis/" service: "Zia Services" related: - Sentiment Analysis - API (/ja/api/code-reference/zia-services/text-analytics/sentiment-analysis/#SentimentAnalysis) - Text Analytics (/ja/zia-services/help/text-analytics/introduction) -------------------------------------------------------------------------------- # Sentiment Analysis Zia Sentiment Analysisは、Text Analyticsの一部で、テキストコンテンツを処理してメッセージのトーンと、そこから伝わる感情を認識します。テキスト内の各文を分析して、そのトーンがpositive、negative、またはneutralのいずれであるかを判定します。次に、各文で認識された感情に基づいて、テキスト全体のトーンをこれら3つの感情のいずれかとして判定します。 レスポンスには、各文で検出された感情の信頼度スコアも返され、分析の精度が示されます。信頼度スコアは0から1の範囲です。全体的な分析の信頼度スコアも返されます。 1回のリクエストで最大1500文字のテキストブロックを入力として渡すことができます。入力テキストはgetSentimentAnalysis()に渡されます。 テキストに対してオプションのキーワードを渡すこともできます。これにより、Sentiment Analysisはそれらのキーワードを含む文のみを処理して、感情を判定します。他の文は無視されます。 以下で使用されているziaリファレンスは、 コンポーネントインスタンスページで定義されています。 zia.getSentimentAnalysis(['Zoho Corporation, is an Indian multinational technology company that makes web-based business tools. It is best known for Zoho Office Suite. The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton, California.'], ['Zoho']) //テキストとオプションのキーワードを渡して処理する .then((result) => console.log(result)) .catch((error) => console.log(error.toString())); 受信するサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 #### Node js "sentiment_prediction": [ { "document_sentiment": "Neutral", "sentence_analytics": [ { "sentence": "Zoho Corporation, is an Indian multinational technology company that makes web-based business tools.", "sentiment": "Neutral", "confidence_scores": { "negative": 0, "neutral": 1, "positive": 0 } }, { "sentence": "It is best known for Zoho Office Suite.", "sentiment": "Neutral", "confidence_scores": { "negative": 0, "neutral": 0.6, "positive": 0.4 } }, { "sentence": "The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton, California.", "sentiment": "Neutral", "confidence_scores": { "negative": 0, "neutral": 0.88, "positive": 0.12 } } ], "overall_score": 0.83 } ] -------------------------------------------------------------------------------- title: "固有表現認識" description: "このページでは、アプリケーションで固有表現認識機能を使用する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.344Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/text-analytics/named-entity-recognition/" service: "Zia Services" related: - Text Analytics (/ja/zia-services/help/text-analytics/introduction) - Named Entity Recognition - API (/ja/api/code-reference/zia-services/text-analytics/named-entity-recognition/#NamedEntityRecognition) -------------------------------------------------------------------------------- # Named Entity Recognition Zia Named Entity Recognitionは、Text Analyticsの一部で、テキストコンテンツを処理してキーワードを抽出し、さまざまなカテゴリにグループ化します。たとえば、テキスト内の単語が組織名、人名、または日付であることを判定し、適切なカテゴリに追加します。NERが認識するすべてのカテゴリのリストについては、こちらを参照してください。 レスポンスは、テキスト内で認識されたすべてのエンティティの配列と、所属するカテゴリを示すタグを返します。また、各分類の信頼度スコアもパーセント値で含まれ、精度が示されます。レスポンスには、テキスト内のエンティティの位置を示す開始インデックスと終了インデックスも返されます。 以下に示すように、1回のリクエストで最大1500文字のテキストブロックを入力として渡すことができます。テキストはgetNERPrediction()に渡されます。 以下で使用されているziaリファレンスは、コンポーネントインスタンスページで定義されています。 zia.getNERPrediction(['Zoho Corporation, is an Indian multinational technology company that makes web-based business tools. It is best known for Zoho Office Suite. The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton, California.']) //入力テキストを渡す .then((result) => console.log(result)) .catch((error) => console.log(error.toString())); 受信するサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 #### Node js "ner": { "general_entities": [ { "start_index": 0, "confidence_score": 98, "end_index": 16, "ner_tag": "Organization", "token": "Zoho Corporation" }, { "start_index": 24, "confidence_score": 99, "end_index": 30, "ner_tag": "Miscellaneous", "token": "Indian" }, { "start_index": 122, "confidence_score": 90, "end_index": 139, "ner_tag": "Miscellaneous", "token": "Zoho Office Suite" }, { "start_index": 168, "confidence_score": 99, "end_index": 181, "ner_tag": "Person", "token": "Sridhar Vembu" }, { "start_index": 186, "confidence_score": 96, "end_index": 197, "ner_tag": "Person", "token": "Tony Thomas" }, { "start_index": 220, "confidence_score": 100, "end_index": 225, "ner_tag": "Number", "token": "seven" }, { "start_index": 268, "confidence_score": 99, "end_index": 275, "ner_tag": "City", "token": "Chennai" }, { "start_index": 277, "confidence_score": 98, "end_index": 282, "ner_tag": "Country", "token": "India" }, { "start_index": 314, "confidence_score": 99, "end_index": 324, "ner_tag": "City", "token": "Pleasanton" }, { "start_index": 326, "confidence_score": 91, "end_index": 336, "ner_tag": "State", "token": "California" } ] } -------------------------------------------------------------------------------- title: "キーワード抽出" description: "このページでは、Node.jsアプリケーションでキーワード抽出機能を使用する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.344Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/text-analytics/keyword-extraction/" service: "Zia Services" related: - Text Analytics (/ja/zia-services/help/text-analytics/introduction) - Keyword Extraction - API (/ja/api/code-reference/zia-services/text-analytics/keyword-extraction/#KeywordExtraction) -------------------------------------------------------------------------------- # Keyword Extraction Zia Keyword Extractionは、Text Analyticsの一部で、テキストコンテンツを処理してテキストのハイライトを抽出します。抽出された用語は、Keywordsと Keyphrasesの2つのカテゴリにグループ化されます。これらのハイライトは、テキストの簡潔な要約を提供し、テキスト全体の抽象化を提供します。 レスポンスには、テキストから抽出されたキーワードの配列と、キーフレーズの配列が含まれます。 以下に示すように、1回のリクエストで最大1500文字のテキストブロックを入力として渡すことができます。テキストはgetKeywordExtraction()に渡されます。キーワードとキーフレーズは個別のリストとして取得されます。 以下で使用されているziaリファレンスは、 コンポーネントインスタンスページで定義されています。 zia.getKeywordExtraction(['Zoho Corporation, is an Indian multinational technology company that makes web-based business tools. It is best known for Zoho Office Suite. The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton, California.']) //入力テキストを渡す to be processed .then((result) => console.log(result)) .catch((error) => console.log(error.toString())); 受信するサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 #### Node js "keyword_extractor": { "keywords": [ "Chennai", "company", "India", "Indian", "presence", "locations", "Pleasanton", "California" ], "keyphrases": [ "corporate headquarters", "multinational technology company", "Zoho Corporation", "Zoho Office Suite", "global headquarters", "Tony Thomas", "web-based business tools", "Sridhar Vembu" ] } -------------------------------------------------------------------------------- title: "すべてのテキスト解析" description: "このページでは、Node.jsアプリケーションでText Analytics機能を使用する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.344Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/zia-services/text-analytics/all-text-analytics/" service: "Zia Services" related: - All Text Analytics - API (/ja/api/code-reference/zia-services/text-analytics/all-text-analytics/#AllTextAnalytics) - Text Analytics (/ja/zia-services/help/text-analytics/introduction) -------------------------------------------------------------------------------- # All Text Analytics Text Analyticsは、前のセクションで説明した3つの機能すべてを組み合わせたものです：Sentiment Analysis、Named Entity Recognition、およびKeyword Extraction。特定のテキストブロックに対してこれら3つのアクションすべてを実行し、テキストのトーン、そこから認識されたエンティティの分類、およびテキストの要旨を提供するキーワードやフレーズを取得できます。 以下に示すように、1回のリクエストで最大1500文字のテキストブロックを入力として渡すことができます。テキストはgetTextAnalytics()に渡されます。また、それらのキーワードを含む文に対してのみSentiment Analysisを実行するためのオプションのキーワードを渡すこともできます。 レスポンスには、各テキスト分析機能の結果が含まれます。それぞれの機能と応答の詳細については、各機能のページを参照してください。 以下で使用されているziaリファレンスは、 コンポーネントインスタンスページで定義されています。 zia.getTextAnalytics(['Zoho Corporation, is an Indian multinational technology company that makes web-based business tools. It is best known for Zoho Office Suite. The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton, California.'], ['Zoho']) //入力テキストを渡す for all Text Analytics, and the keywords for Sentiment Analysis .then((result) => console.log(result)) .catch((error) => console.log(error)); 受信するサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 [ { "keyword_extractor": { "keywords": [ "Chennai", "company", "India", "Indian", "presence", "locations", "Pleasanton", "California" ], "keyphrases": [ "corporate headquarters", "multinational technology company", "Zoho Corporation", "Zoho Office Suite", "global headquarters", "Tony Thomas", "web-based business tools", "Sridhar Vembu" ] }, "sentiment_prediction": [ { "document_sentiment": "Neutral", "sentence_analytics": [ { "sentence": "Zoho Corporation, is an Indian multinational technology company that makes web-based business tools.", "sentiment": "Neutral", "confidence_scores": { "negative": 0, "neutral": 1, "positive": 0 } }, { "sentence": "It is best known for Zoho Office Suite.", "sentiment": "Neutral", "confidence_scores": { "negative": 0, "neutral": 0.6, "positive": 0.4 } }, { "sentence": "The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton, California.", "sentiment": "Neutral", "confidence_scores": { "negative": 0, "neutral": 0.88, "positive": 0.12 } } ], "overall_score": 0.83 } ], "ner": { "general_entities": [ { "start_index": 0, "confidence_score": 98, "end_index": 16, "ner_tag": "Organization", "token": "Zoho Corporation" }, { "start_index": 24, "confidence_score": 99, "end_index": 30, "ner_tag": "Miscellaneous", "token": "Indian" }, { "start_index": 122, "confidence_score": 90, "end_index": 139, "ner_tag": "Miscellaneous", "token": "Zoho Office Suite" }, { "start_index": 168, "confidence_score": 99, "end_index": 181, "ner_tag": "Person", "token": "Sridhar Vembu" }, { "start_index": 186, "confidence_score": 96, "end_index": 197, "ner_tag": "Person", "token": "Tony Thomas" }, { "start_index": 220, "confidence_score": 100, "end_index": 225, "ner_tag": "Number", "token": "seven" }, { "start_index": 268, "confidence_score": 99, "end_index": 275, "ner_tag": "City", "token": "Chennai" }, { "start_index": 277, "confidence_score": 98, "end_index": 282, "ner_tag": "Country", "token": "India" }, { "start_index": 314, "confidence_score": 99, "end_index": 324, "ner_tag": "City", "token": "Pleasanton" }, { "start_index": 326, "confidence_score": 91, "end_index": 336, "ner_tag": "State", "token": "California" } ] } } #### サーバーレス ##### AppSail -------------------------------------------------------------------------------- title: "AppSailでのSDK実装" description: "このページでは、AppSailサービスでPython SDKを実装し、アプリケーション内でCatalystの機能を利用するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.345Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/serverless/appsail/implement-sdk-in-appsail/" service: "Serverless" related: - AppSail Help (/ja/serverless/help/appsail/introduction) -------------------------------------------------------------------------------- # Catalyst AppSail Catalyst AppSailは、Catalyst Serverlessの完全マネージド型の独立したPlatform-as-a-Service（PaaS）コンポーネントであり、クラウドでサービスを簡単に開発・デプロイできます。AppSailアプリケーションは、Catalyst固有のコーディング構造に依存せずに構築でき、Catalystはそのための強力でスケーラブルなプラットフォームを提供します。AppSailは、Flask、Django、Bottle、CherryPyなどのすべてのPythonフレームワークをサポートしています。 # AppSailでのPython SDK実装 AppSailサービスのコードベースにCatalyst Python SDKを簡単に実装できます。SDKは各リクエストの前にリクエストオブジェクトで初期化する必要があります。 以下は、Flask WebアプリでPython SDKをインポートして初期化する例です。 from flask import Flask, request, g import os import zcatalyst_sdk from zcatalyst_sdk.catalyst_app import CatalystApp app = Flask(__name__) @app.before_request def before_request(): if request.path.startswith('/admin'): return 'Unauthorized', 401 # 認可済みユーザーの場合 g.zc_app = zcatalyst_sdk.initialize(req=request) @app.route('/') def index(): return 'Web App with Python Flask!' @app.route('/cache') def cache(): app: CatalystApp = g.zc_app resp = app.cache().segment().put('key', 'value') return resp, 200 listen_port = os.getenv('X_ZOHO_CATALYST_LISTEN_PORT', 9000) app.run(host='0.0.0.0', port = listen_port) 情報: 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 ##### Circuits -------------------------------------------------------------------------------- title: "Circuitの実行" description: "このページでは、サンプルコードスニペットを使用して、JavaアプリケーションでCircuitsを使用してタスクを整理・オーケストレーションするメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.345Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/serverless/circuits/execute-circuit/" service: "Serverless" related: - Execute Circuit - API (/ja/api/code-reference/serverless/circuits/execute-circuit/#ExecuteCircuit) - Circuits (/ja/serverless/help/circuits/introduction) -------------------------------------------------------------------------------- # Circuitの実行 Catalyst Circuitsを使用すると、自動的に実行される一連のタスクを定義、整理、およびオーケストレーションできます。Circuit内でCatalyst関数の並行または逐次実行を有効にし、さらに条件、データ、パスを含めてワークフローを自動化できます。 注意: Circuitsは現在、EU、AU、IN、JP、SA、またはCAデータセンターからアクセスするCatalystユーザーには利用できません。 以下のサンプルコードは、一意のCircuit IDを参照してCircuitを実行し、キーと値のペアを入力JSONとしてCircuitに渡す方法を示しています。また、Circuitの実行履歴に保存された一意のExecution IDを参照して、Circuitの実行詳細を取得する方法も示しています。 以下で使用されているcircuit参照は、コンポーネントインスタンスページで定義されています。 //サーキットIDを参照してサーキットを実行し、入力JSONを渡す circuit.execute('195000000041001', 'sampleName', { name: 'Aaron Jones'}).then((result) => { console.log(result); }).catch((err) => console.log(err.toString())); //Catalyst logsに書き込まれる //サーキットIDと実行IDを参照してサーキットの実行詳細を返す circuit.status('195000000041001', '195000000043002').then((result) => { console.log(result); }).catch((err) => console.log(err.toString())); //Written to Catalyst Logs //サーキットIDと実行IDを参照してサーキットの実行を中断する circuit.abort('195000000041001', '195000000043002').then((result) => { console.log(result); }).catch((err) => console.log(err.toString())); //Written to Catalyst Logs 受信するサンプルレスポンスを以下に示します。レスポンスはNode.jsの両方のバージョンで同じです。 #### Node.js { id: "b3e2f61e-4795-428e-8365-3609bf2b5606", name: "Name", start_time: "Aug 18, 2021 07:35 PM", status: "running", status_code: 1, execution_meta: {}, circuit_details: { name: "NewCircuit", ref_name: "newcircuit", description: "", instance_id: "70454fc5-3bf6-45af-81ca-2742cc049698" }, input: { name: "Aaron Jones" } } -------------------------------------------------------------------------------- title: "Circuitインスタンスの取得" description: "このページでは、サンプルコードスニペットを使用して、NodeJSアプリケーションでCircuitsを使用してタスクを整理・オーケストレーションするメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.345Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/serverless/circuits/get-a-component-instance/" service: "Serverless" related: - Circuits (/ja/serverless/help/circuits/introduction) -------------------------------------------------------------------------------- # Circuits ### コンポーネントインスタンスの取得 以下の方法でcircuitの参照を作成できます。これはサーバーサイドの呼び出しを実行しません。 Circuitsは現在、EU、AU、IN、JP、SA、またはCAデータセンターからアクセスするCatalystユーザーには利用できません。 //サーキットインスタンスを取得する let circuit = app.circuit(); ##### ファンクション -------------------------------------------------------------------------------- title: "Functionsインスタンスの取得" description: "このページでは、サンプルコードスニペットを使用して、NodeJSアプリケーションでFunctionsを実行するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.345Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/serverless/functions/get-component-instance/" service: "Serverless" related: - Functions (/ja/serverless/help/functions/introduction) -------------------------------------------------------------------------------- # Functions Catalystのファンクショングループは、Catalystのオンラインエディターまたはコマンドラインインターフェース（CLI）を通じて作成・定義されます。ファンクショングループ内の関数は、テスト環境および本番環境で実行できます。 #### コンポーネントインスタンスの取得 以下のメソッドを使用して関数の参照を作成できます。このメソッドはサーバーサイドの呼び出しを実行しません。 //関数インスタンスを取得する let functions = app.functions(); -------------------------------------------------------------------------------- title: "関数の実行" description: "このページでは、サンプルコードスニペットを使用して、NodeJSアプリケーションでFunctionsを実行するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.345Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/serverless/functions/execute-function/" service: "Serverless" related: - Execute Function - API (/ja/api/code-reference/serverless/functions/execute-function/#ExecuteFunction) - Functions (/ja/serverless/help/functions/introduction) -------------------------------------------------------------------------------- # 関数の実行 関数IDと設定（JSON型）をパラメーターとして渡す_execute()_メソッドを呼び出すことで、関数を実行できます。以下のコードスニペットで使用されている_functions_参照は、コンポーネントインスタンスです。 #### 関数設定（JSON）の作成 関数を実行する前に、必要な設定を行う必要があります。ここでは、設定で関数の引数とその値を指定します。（関数パラメーター） 設定は以下のコードスニペットを使用して行えます： //Create Configuration for function Execution let conf = { args: { Name: 'Amelia' } } ### 関数の実行 実行する関数を呼び出すために、一意の関数IDがパラメーターとしてexecute()関数に渡され、必要な設定とともに実行されます。 ここで返されるPromiseは、JSONであるオブジェクトに解決されます。 let functions = app.functions(); //関数IDと設定でFunctionを呼び出す let promiseResult = functions.execute(1510000000059262, conf); promiseResult.then((functionResponse) => { console.log(functionResponse); }); 注意: 関数IDの代わりに、関数名を文字列としてexecute()メソッドに渡すこともできます。 #### コネクター -------------------------------------------------------------------------------- title: "コネクター" description: "このページでは、サンプルコードスニペットを使用して、NodeJSアプリケーションでコネクターを使用してアクセストークンを管理するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.345Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/connectors/connectors/" service: "All Services" -------------------------------------------------------------------------------- # Catalyst Connectors Catalyst Connectorは、**Zoho OAuth認証**を通じて確立されるCatalystと外部Zohoサービス間のシームレスな接続を提供します。ビジネスロジックにZoho CRMやZoho WorkDrive APIなどの外部ZohoサービスのAPIの使用が含まれる場合、Catalystアプリケーションでコネクターを利用できます。 Catalystは、Zoho APIコンソールで特定のアプリケーション用に生成したアクセストークンを、有効期限が切れるまでCatalyst Cacheに保存することで接続を処理します。有効期限が切れると、コネクターはリフレッシュトークンを使用して新しいアクセストークンを自動的に取得し、キャッシュに保存します。アクセストークンが期限切れになるたびに、コネクターがバックグラウンドで自動的に新しいトークンを取得してキャッシュするため、アプリケーションのビジネスロジックで外部Zohoサービスとの中断のない接続を維持するロジックを構築する手間が省けます。 注意: Catalyst Connectorは外部Zohoサービスとの接続を維持するためにのみ使用でき、サードパーティサービスには使用できません。これは、すべてのZohoサービスで維持されているOAuth標準が統一されており、CatalystがConnectors機能を実装するために互換性があるためです。 以下に示すようにNode.jsのビジネスロジックでコネクターを設定する前に、Zoho APIコンソールで新しいクライアントを登録し、初回の認可コードとアクセストークンを生成する手順に従う必要があります。その後、受け取ったリフレッシュトークンと、Client ID、Client Secret、認証URL、リフレッシュURLなど、アクセストークンを定期的に自動更新するために必要な標準的なOAuthパラメーターを使用してコネクターを設定できます。また、要件に応じてコネクターに独自のロジックを組み込むこともできます。 注意: * ロジック内の各コネクターに指定する名前は一意である必要があります。 * Zoho APIコンソールでサーバーベースのアプリケーションを作成し、同じアプリケーション内の異なるユーザーに対してアクセストークンの作成を許可する場合は、各ユーザーに対して異なる一意のコネクター名を指定する必要があります。これは、同じコネクターがアプリケーション内の異なるユーザーに使用されると、同じキャッシュセグメントでトークンが上書きされ、外部Zohoサービスから誤ったユーザーのデータが取得されるためです。 以下のコードは、Node.jsコネクターを示しています。ここで返されるPromiseは、アクセストークン文字列に解決されます。 var connector = app.connection({ ConnectorName: { client_id: '{add_client_id}', client_secret: '{add_client_secret}', auth_url: '{add_auth_url}', refresh_url: '{add_refresh_url}', refresh_token: '{add_refresh_token}', refresh_in: '{add_refresh_in}' //Zoho APIコンソールでアプリを登録し認証コードを生成した後に返された値からOAuthパラメータを設定する } }) .getConnector('{ConnectorName}'); //Provide a unique connector name for each connector you create connector.getAccessToken().then((accessToken) => { // カスタムロジックをここに追加する }); #### 一般 ##### プロジェクト -------------------------------------------------------------------------------- title: "プロジェクト初期化時にキャッシュされたプロジェクトデータの取得" description: "このページでは、プロジェクト初期化時にキャッシュされたプロジェクトデータを取得するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.345Z" source: "https://docs.catalyst.zoho.com/ja/sdk/nodejs/v2/general/projects/retreive-cached-project-data/" service: "All Services" related: - Projects - API (/ja/api/code-reference/general/projects/create-new-project/#CreateNewProject) - Initialize Projects (/ja/cli/v1/initialize-resources/initialize-new-project/) -------------------------------------------------------------------------------- # プロジェクト初期化時にキャッシュされたプロジェクトデータの取得 Catalystでは、初期化時にプロジェクトデータをアプリオブジェクトとしてバックエンドにキャッシュできます。 以下のSDKスニペットは、キャッシュされたアプリオブジェクトをいつでも取得する方法を示しています。 const catalyst = require('zcatalyst-sdk-node'); catalyst.initialize(req, { scope: "user", appName: 'user_app'}) // アプリ名とユーザースコープでCatalystを初期化する const app = catalyst.app('user_app'); // appNameでCatalystアプリのインスタンスを取得する ## Python ### v1 -------------------------------------------------------------------------------- title: "概要" description: "Catalyst Python SDKは、Catalystプロジェクト向けのPythonアプリケーションを構築するためのライブラリです。Catalyst Python SDKパッケージには、強力なバックエンドを備えた動的で堅牢なPythonアプリケーションの開発を支援するさまざまなツールや機能が含まれています。" last_updated: "2026-06-10T06:04:54.346Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/overview/" service: "All Services" related: - Java SDK (/ja/sdk/java/v1/overview/) - Node.js SDK (/ja/sdk/nodejs/v2/overview/) - Web SDK (/ja/sdk/web/v4/overview/) - Serverless Functions (/ja/serverless/help/functions/introduction/) -------------------------------------------------------------------------------- # Python SDK ## 概要 Catalyst Python SDKは、強力なPythonプログラミング要素を使用して堅牢なCatalystアプリケーションやマイクロサービスを構築するためのライブラリです。SDKパッケージには、さまざまなCatalystサービスとそれぞれのコンポーネントにアクセスするために使用できる、定義済みのモジュール、クラス、関数が含まれています。Python SDKの主な目的は、Catalystアプリケーションを構築するためのすぐに利用可能なPython環境を提供することです。 すべてのCatalystコンポーネントのコア属性と動作はSDKの一部としてあらかじめ構成されているため、すぐにアクセスしてCatalyst Serverless functions内で必要なコンポーネント機能を実装し、その上にアプリケーションロジックを簡単に構築できます。Python プログラミング環境を使用して、Basic I/O、Advanced I/O、Cron、Event、またはIntegration関数を作成できます。 SDKパッケージは、必要なコンポーネント固有の機能をオブジェクトを使用してSDK内の定義済みPythonメソッドを呼び出すことで即座にアクセスできるため、特定のアプリケーション機能をゼロから構築するために費やす時間と労力を最小限に抑えることができます。Catalyst Python SDKパッケージを使用すると、ユーザー認証、Data StoreおよびFile Store固有のアクション、キャッシング、クエリ、検索、ドキュメント処理、ワークフロー管理、Catalyst関数の実行など、複数のバックエンドジョブを実行できます。 Python SDKドキュメントでは、Python環境でCatalystアプリケーションを構築するプロセスについて説明しています。このドキュメントでは、SDKパッケージのコンポーネント、設定、SDKメソッドのスコープについて学び、さまざまな操作のサンプルコードスニペットにアクセスすることもできます。 -------------------------------------------------------------------------------- title: "コンポーネント" description: "このページでは、Catalyst Python SDKに含まれるCatalystサービスとコンポーネントに関する情報を説明します。" last_updated: "2026-06-10T06:04:54.346Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/components/" service: "All Services" related: - CloudScale Help (/ja/cloud-scale/getting-started/introduction) - Serverless Help (/ja/serverless/getting-started/introduction) - Zia Services Help (/ja/zia-services/getting-started/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Python SDKのコンポーネント Catalyst Python SDKは、すべてのCatalystコンポーネントと連携するための定義済みパッケージとモジュールで構成されています。各モジュール内のクラスには、アプリケーションでCatalystコンポーネントを使用してさまざまな操作を実行するためのメソッドが含まれています。 **zcatalyst-sdk**は、Catalyst Python SDKのベースパッケージです。SDKパッケージを初期化し、アプリケーションにさまざまなCatalystコンポーネントを実装できるようにします。zcatalyst-sdkパッケージを使用すると、以下のCatalystサービスのコンポーネントを実装できます： ### Cloud Scale * Authentication * Data Store * File Store * Stratus * No SQL * Search * Cache * Mail * Push Notifications ### Serverless * Functions * AppSail * Circuits ### Zia Services * OCR * Face Analytics * Identity Scanner * Image Moderation * Object Recognition * Barcode Scanner * Text Analytics ### その他のサービス * Job Scheduling * Pipelines 注意: 上記のコンポーネントで利用可能な操作のスコープについては、スコープテーブルで確認できます。 zcatalyst-sdkパッケージ内のエンティティの階層構造を以下の図に示します。Data Store、File Store、Cache、Push NotificationsなどのコンポーネントやZiaサービスに含まれるコンポーネントのコア機能は、ベースパッケージ内の個別のサブパッケージに構成されています。Authentication、Circuits、Functions、Search、Cron、ZCQLなどの他のコンポーネントの機能は、ベースパッケージ内の個別モジュールとして構成されており、対応するPythonクラスとメソッドが含まれています。 ### インスタンスオブジェクト zcatalyst-sdkベースパッケージには、各Catalystコンポーネント用の定義済みPythonモジュールとパッケージが含まれています。モジュール内のクラスには、Catalystコンポーネントを使用して実行する各操作に対応するメソッドが含まれています。SDKの初期化時に取得できるPythonオブジェクトのインスタンスを作成することで、メソッドにアクセスできます。Python SDKの初期化の詳細な手順については、セットアップヘルプページを参照してください。 **インスタンスオブジェクト**または**コンポーネントインスタンス**は、特定のコンポーネントに固有のPythonクラスに存在するメソッドにアクセスして、Catalystコンポーネントのプロパティを取得するために使用できるダミーオブジェクトです。 したがって、特定のCatalystコンポーネントのプロパティを取得するには、定義済みメソッドを使用してコンポーネントのオブジェクトインスタンスを呼び出す必要があります。 -------------------------------------------------------------------------------- title: "SDKスコープ" description: "このページでは、Python SDKのSDKスコープについて説明します。" last_updated: "2026-06-10T06:04:54.347Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/sdk-scopes/" service: "All Services" related: - Catalyst Java SDK (/ja/sdk/java/v1/overview/) - Catalyst Node.js SDK (/ja/sdk/node/v2/overview/) -------------------------------------------------------------------------------- # Python SDKスコープ このセクションでは、サポートされているさまざまなSDK操作とそれに対応するスコープについて説明します。これらの操作を実行するには、テーブルに記載されているとおり、**Admin**または**User**スコープでSDKを初期化する必要があります。必要なスコープでSDKを初期化する方法の詳細については、こちらのセクションを参照してください。 <table class="content-table"> <thead> <tr> <th class="w30p">サービス名</th> <th class="w70p">コンポーネント名</th> <th class="w70p">SDK操作</th> <th class="w70p">スコープ</th> </tr> </thead> <tbody> <tr> <td>Catalyst CloudScale</td> <td>DataStore</td> <td>Get Meta Data of All Tables, Get All Columns, Get Column Details, Delete Single Row, Delete All Rows, Update Single Row, Update All Rows, Get Row, Get All Rows </td> <td>User, Admin</td> </tr> <tr> <td>Catalyst CloudScale</td> <td>DataStore</td> <td>Bulk Operations</td> <td>Admin</td> </tr> <tr> <td>Catalyst CloudScale</td> <td>FileStore</td> <td>Get Details of All Folders, Get Details of a Single Folder, Upload a File, Download a File, Delete a File</td> <td>User, Admin</td> </tr> <tr> <td>Catalyst CloudScale</td> <td>FileStore</td> <td>Other File Operations</td> <td>Admin</td> </tr> <tr> <td>Catalyst CloudScale</td> <td>User Management</td> <td>Get Details of Current User, Reset Password </td> <td>User, Admin</td> </tr> <tr> <td>Catalyst CloudScale</td> <td>Cache</td> <td>すべての操作</td> <td>Admin</td> </tr> <tr> <td>Catalyst CloudScale</td> <td>Search</td> <td>Execute Search Query</td> <td>User, Admin</td> </tr> <tr> <td>Catalyst CloudScale</td> <td>ZCQL</td> <td>Execute Query</td> <td>User, Admin</td> </tr> <tr> <td>Catalyst CloudScale</td> <td>Email</td> <td>Send Mail</td> <td>User, Admin</td> </tr> <tr> <td>Catalyst CloudScale</td> <td>Push Notifications</td> <td>すべての操作</td> <td>Admin</td> </tr> <tr> <td>Catalyst Serverless</td> <td>Circuits</td> <td>すべての操作</td> <td>Admin</td> </tr> <tr> <td>Catalyst Zia Services</td> <td>すべてのコンポーネント</td> <td>すべての操作</td> <td>Admin</td> </tr> <tr> <td>Catalyst Quick ML</td> <td>すべてのコンポーネント</td> <td>すべての操作</td> <td>Admin</td> </tr> <tr> <td>Catalyst SmartBrowz</td> <td>すべてのコンポーネント</td> <td>すべての操作</td> <td>Admin</td> </tr> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "セットアップ" description: "このページでは、Python SDKのセットアップと初期化の手順について説明します。" last_updated: "2026-06-10T06:04:54.347Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/setup/" service: "All Services" related: - Install Python (https://www.python.org/) - Install Pip (https://pip.pypa.io/ja/stable/installation/#) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Python SDK セットアップ ### 前提条件 ローカル環境でCatalyst Python SDKを使用してアプリケーションロジックの開発を始める前に、以下のパッケージマネージャーとプログラミング環境がローカルマシンにインストールされていることを確認してください： * **Pip - Pythonパッケージマネージャー** * **Python バージョン 3.9 〜 3.13** Pythonは公式ウェブサイトからインストールでき、pipパッケージマネージャーはローカルシステムに自動的にインストールされます。他のソースからPythonをインストールする場合は、pipパッケージを手動でインストールしてください。pipのインストールについては、pipインストールドキュメントを参照してください。 注意: ローカルマシンにサポートされている範囲外のバージョンのPython（Python 3.9〜3.13以外のバージョン）がインストールされている場合、アプリケーションのサーブまたはデプロイ時に、ディレクトリ内のPython関数の実行がスキップされます。これらのPython関数は、コンソールからCLIに関数をプルする際にも除外されます。 既存のCatalystプロジェクトのローカルディレクトリでPython関数を作成する場合は、上記の前提条件をインストールしてから、関数のセットアップに進んでください。既存のプロジェクトディレクトリでPython関数をセットアップする手順は、こちらのヘルプページに記載されています。Catalystプロジェクトの初期化時にPython関数を初期化する方法については、こちらのヘルプページを参照してください。 <br> ### SDKのインストール CLIでCatalystプロジェクトを初期化し、ローカル環境の既存のプロジェクトディレクトリでPython関数を作成またはセットアップすると、Python SDKパッケージ（zcatalyst-sdk）が現在のプロジェクトのfunctionsディレクトリ内に自動的にインストールされます。 任意のプログラミングスタックのCatalyst Serverless functionを作成すると、メイン関数ファイルと設定ファイルがデフォルトでボイラープレートコードとともに関数のディレクトリに自動生成されます。Python関数の場合は、requirements.txtという名前の追加ファイルも作成されます。このファイルには、Python関数を実装するために必要なインストール済み依存関係のリストが含まれています。CLIからPython関数を作成すると、デフォルトでCatalystのPython SDKパッケージ（zcatalyst-sdk）のエントリが含まれます。外部の依存関係をインストールする必要がある場合は、requirements.txtファイルに依存関係の名前を手動で追加する必要があります。 注意: Python関数を初めて初期化する場合は、システムにインストールされているPythonのパス情報を追加で設定する必要があります。この情報は、ローカルシステムに隠しファイルとして存在する特定の設定ファイルで設定できます。パスはconfig:set &lt;key=value&gt; CLIコマンドを使用して設定する必要があります。このコマンドの詳細については、こちらのヘルプページを参照してください。 以下のコマンドを使用して、Catalyst Python SDKをシステムにグローバルにインストールできます： pip install zcatalyst-sdk <br> ### SDKの初期化 Python SDKが関数のディレクトリにインストールされたら、Python関数のコーディングを開始できます。まず、現在のプロジェクトのCatalystコンポーネントにアクセスするために、関数のコード内でinitialize()メソッドを使用してSDKを初期化する必要があります。Catalyst関数タイプの初期化メソッドを以下に示します： **Basic I/O Functions** import zcatalyst_sdk def handler(context, basicio): app = zcatalyst_sdk.initialize() #このapp変数はCatalystコンポーネントにアクセスするために使用されます。 #ここにビジネスロジックを記述する **Advanced I/O Functions** import zcatalyst_sdk def handler(request: Request): app = zcatalyst_sdk.initialize() #このapp変数はCatalystコンポーネントにアクセスするために使用されます。 #ここにビジネスロジックを記述する **Event Functions** import zcatalyst_sdk def handler(event, context): app = zcatalyst_sdk.initialize() #このapp変数はCatalystコンポーネントにアクセスするために使用されます。 #ここにビジネスロジックを記述する **Cron Functions** import zcatalyst_sdk def handler(cron_details, context): app = zcatalyst_sdk.initialize() #このapp変数はCatalystコンポーネントにアクセスするために使用されます。 #ここにビジネスロジックを記述する 関数内でSDKパッケージを初期化すると、レスポンスとしてPythonオブジェクトが返されます。このオブジェクトを使用して、Pythonクラスで定義されたコンポーネント固有のメソッドを呼び出し、必要なCatalystコンポーネントにアクセスできます。 注意 : Python関数は、お好みに応じてウェブコンソールまたはCLIから作成できます。ただし、現時点ではローカルから関数バンドルをアップロードすることのみが可能で、コンソールで直接コーディングすることはできません。今後、オンラインエディターのサポートを提供する予定です。 <br> ### スコープを使用した初期化 Catalystでは、以下のスコープを使用してプロジェクトのSDKを初期化できます： * **Admin**: すべてのコンポーネントとそれぞれの機能に無制限にアクセスできます。たとえば、Data Storeに完全にアクセスして、読み取り、書き込み、削除などのすべての操作を実行できます。 * **User**: コンポーネントや特定の機能へのアクセスを制限できます。たとえば、Data Storeに読み取りアクセスのみを提供できます。 注意:<br /> * スコープを使用してプロジェクトを初期化することは必須ではありません。デフォルトでは、初期化されたプロジェクトにはAdmin権限が付与されます。 * ビジネスロジックを設計する際には、適切なスコープでCatalyst SDKを初期化していることを確認してください。スコープに対して定義した権限が、エンドユーザーのアクションを制御します。 * さまざまなコンポーネントで実行できるSDK操作のスコープの詳細については、スコープテーブルを参照してください。 * ビジネスロジックの設計方法に応じて、エンドユーザーがAdminまたはUserのアクションを実行できるかどうかを決定できます。これは、エンドユーザーがCatalyst Authenticationでアプリケーションにサインアップする際に割り当てられるロールに基づいて決定されます。ロールの権限は、Data StoreとStratusのScopes & PermissionsまたはBucket Permissionsセクションでそれぞれ設定できます。 * Catalyst Stratusは、Early Accessモードの新しいオブジェクトストレージコンポーネントです。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br />Early AccessモードのStratusコンポーネントをご利用になるには、support@zohocatalyst.comまでメールでお問い合わせください。 以下のSDKスニペットを使用すると、*Admin*または*User*スコープでSDKを初期化できます： **Admin Scope** import zcatalyst_sdk def handler(request: Request): app = zcatalyst_sdk.initialize(scope='admin') #このapp変数はCatalystコンポーネントにアクセスするために使用されます。 #コードサンプルについてはSDKドキュメントを参照してください。 #ここにビジネスロジックを記述する **User Scope** import zcatalyst_sdk def handler(request: Request): app = zcatalyst_sdk.initialize(scope='user') #このapp変数はCatalystコンポーネントにアクセスするために使用されます。 #コードサンプルについてはSDKドキュメントを参照してください。 #ここにビジネスロジックを記述する 次のセクションでは、Python SDKのアップグレードについて説明します。 -------------------------------------------------------------------------------- title: "SDKのアップグレード" description: "このページでは、コード内のPython SDKをサポートされている最新バージョンにアップグレードする手順について説明します。" last_updated: "2026-06-10T06:04:54.347Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/upgrade-sdk/" service: "All Services" related: - Catalyst Java SDK (/ja/sdk/java/v1/overview/) - Catalyst Node.js SDK (/ja/sdk/node/v2/overview/) -------------------------------------------------------------------------------- # Python SDKのアップグレード Catalystは、開発プロセスを効率化するために、最新かつ最も安全で効率的なSDKパッケージを常に提供するよう努めています。また、テクノロジーのアップグレードに基づいてSDKサポートもアップグレードしています。つまり、Pythonの新しいバージョンがリリースされると、CatalystはSDKツールキットにそれを実装します。 これは、Catalystが最適なコーディングサポートを提供するために、SDKバージョンを随時アップグレードすることを意味します。リリースノートを通じて最新のCatalyst SDKの更新やバグ修正を把握し、利用可能になり次第、最新バージョンにアップグレードすることをお勧めします。SDKの更新はPythonの公式リリースに準拠しており、最新の機能強化を取り入れるとともに、非推奨のバージョンを段階的に廃止しています。さらに、SDKエクスペリエンスを向上させるために、新しいコンポーネントや機能を継続的に導入しています。 注意: 古いSDKバージョンの非推奨化により、SDKの即時アップグレードが必要な場合は、必要なアップグレードを実行するためにメールで適時通知いたします。一般的に、常にSDKを最新バージョンにアップグレードすることを強くお勧めします。 SDKはグローバルおよびPython関数内でアップグレードできます。このヘルプドキュメントでは、両方の場所でSDKをアップグレードする手順について説明します。 注意: SDKをグローバルにアップグレードしても、既存の関数には更新されたバージョンが自動的に反映されません。グローバルバージョンを適用するには、各関数のrequirements.txtファイルから指定されたバージョンを削除する必要があります。 <br> ### SDKのグローバルアップグレード Catalyst Python SDKをグローバルにアップグレードするには、ターミナルの任意のディレクトリから以下のコマンドを使用できます： 特定のパッケージをインストール 特定のPython SDKバージョンのパッケージをインストールするには、以下のコマンドを実行してください。SDKパッケージのバージョン番号を必要なものに置き換えてください。 pip install zcatalyst-sdk==0.0.2 <br/> 注意: 1. 特定のバージョンではなく、常に最新バージョンのSDKをインストールすることをお勧めします。 2. デフォルトでは、Python関数の実行時に、関数はrequirements.txtファイルに記載されたSDKパッケージを参照します。グローバルにインストールされたSDKを使用する場合は、requirements.txtファイルからSDKパッケージを削除してください。 <br> ### 最新バージョンのインストール 最新バージョンのSDKをインストールすると、最新の機能にアクセスでき、最近のバグ修正もすべて含まれます。 任意のタイミングで利用可能な最新バージョンのSDKをインストールするには、以下のコマンドを実行してください： pip install zcatalyst-sdk <br> ### 関数内でのSDKアップグレード 特定の関数のCatalyst Python SDKをアップグレードするには、以下の手順に従ってください： 1. ターミナルを起動し、Python関数のソースディレクトリに移動します。たとえば、CLIを通じてシステムにインストールされた「Pets Conglomerate」という名前のCatalystプロジェクトがあるとします：**/Users/user/apps/petsConglomerate**。このプロジェクトに「dogs_spotted」という名前の関数がある場合、関数のソースディレクトリに移動する必要があります。パスは次のようになります：**/Users/user/apps/petsConglomerate/functions/dogs_spotted** 2. この関数のディレクトリにあるrequirements.txtファイルを開き、Python SDKのバージョンを更新してファイルを保存します。 例：zcatalyst-sdk==1.0.0rc1 3. 以下のコマンドを実行して、更新されたSDKバージョンがCLIインスタンスに反映されていることを確認します。 pip install -r requirements.txt このコマンドにより、最新バージョンの更新がCLIに即座に反映されます。 -------------------------------------------------------------------------------- title: "例外処理" description: "このヘルプページでは、Catalyst Pythonアプリケーションの実行中に発生する可能性のある一般的な例外を一覧で示します。" last_updated: "2026-06-10T06:04:54.347Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/exceptions/" service: "All Services" -------------------------------------------------------------------------------- # 例外処理 例外とは、アプリケーションの実行中に発生する予期しない不具合の動作です。Python環境上に構築されたCatalystアプリケーションによってスローされるすべてのエラーと例外は、Exceptionsモジュールとその中のクラスによって処理されます。 アプリケーションでエラーまたは例外が発生すると、例外の以下のプロパティが返されます： * code: エラーの一意の識別子です。 * errorMsg: エラーに関する一般的な説明です。 * errorDetails: エラーに関する追加情報です。 * originalException: HTTPリクエストの場合はHTTPステータスコードを返します。それ以外の場合は「None」を返します。 基底クラスCatalystErrorは、Catalyst Python SDKパッケージのExceptionsモジュールに定義済みです。これは複数のサブクラスによって継承され、アプリケーションでのCatalystコンポーネントの実行中に発生する可能性のある例外やエラーのシナリオを処理します。 Python SDKの一部として、各Catalystコンポーネントに個別のエラークラスが構成されており、コンポーネント実行の定義されたフローで予期しないイベントが発生した場合、それぞれのエラーがスローされます。 #### 例： CatalystアプリケーションでCatalyst Serverless functionを実行し、関数がレスポンスとしてエラーコードを返す場合を考えてみましょう。この場合、Functionsコンポーネント用に定義済みのそれぞれのエラークラス(CatalystFunctionError)がシナリオを処理します。 同様に、Catalyst DataStoreで不正なデータベース固有の操作を実行した場合、例外はCatalystDataStoreErrorクラス内でキャッチされ処理されます。 したがって、Exceptionsモジュールの一部として、各Catalystコンポーネントに固有のエラークラスが定義されています。モジュールに含まれるその他の一般的なクラスには、CatalystAuthenticationError、Catalyst FileStore Error、Catalyst CacheError、Catalyst CronError、CatalystZiaErrorなどがあります。 さらに、コンポーネント固有のPythonクラスでキャッチされない例外は、CatalystAPIErrorクラスで処理されます。このクラスはAPIレベルでキャッチされた例外を処理し、失敗したAPIリクエストのエラーコードを定義します。 以下は、すべてのCatalystコンポーネントに適用される一般的なAPIエラーコードの一覧です： <table class="content-table"> <thead> <tr> <th class="w30p">エラーコード</th> <th class="w70p">説明</th> </tr> </thead> <tbody> <tr> <td><strong>INVALID ARGUEMENT ERROR</strong></td> <td>渡された引数が、特定の形式に対して有効な型ではありません。</td> </tr> <tr> <td><strong>INVALID CREDENTIAL ERROR</strong></td> <td>入力された資格情報が有効ではありません。</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "サードパーティアプリケーションへのSDK統合" last_updated: "2026-06-10T06:04:54.347Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/integrate-sdk-in-third-party-apps/" service: "All Services" related: - Catalyst Environments (/ja/deployment-and-billing/environments/introduction/) - Catalyst Cloud Scale Authentication (/ja/cloud-scale/help/authentication/introduction/) - Catalyst Cloud Scale Stratus (/ja/cloud-scale/help/stratus/introduction/) -------------------------------------------------------------------------------- # サードパーティアプリケーションへのCatalyst Python SDKの統合 Catalyst環境外にデプロイされたアプリケーションで、Catalyst Python SDKのメソッドを統合して使用できます。たとえば、Flaskバックエンド（Catalyst外で実行）を使用するVercelにホストされたReactアプリケーションが、それぞれのPython SDK操作を使用してCatalyst Cloud Scale Stratusにドキュメントをアップロードしたり、Amazon Web Services EC2上で実行されるデータパイプラインがCatalyst Cloud Scale ZCQLクエリを使用してCatalyst Cloud Scale Data Storeに顧客データをプッシュしたりできます。 これらは、外部アプリケーションがCatalystプラットフォーム内にデプロイされることなく、Catalystコンポーネントと安全にやり取りできる一般的なユースケースのほんの一例です。 外部アプリケーションとCatalyst Python SDKを統合するためのコードスニペットを提供しています。ただし、アプリケーションにコードを実装する前に、以下の前提条件を確認してください。 ### SDK統合の前提条件 外部アプリケーションにCatalyst Python SDKを統合するには、以下の情報が必要です： * **Project ID:** Catalystプロジェクトの一意の識別子です。 * **ZAID (Zoho Account ID):** プロジェクトをCatalyst環境（developmentまたはproduction）にリンクするためにCatalystによって割り当てられる一意のポータル識別子です。 * **Environment:** Catalystプロジェクトのターゲット環境（developmentまたはproduction）です。 * **OAuth資格情報:** 外部アプリケーションがCatalystのセルフクライアントポータルを通じてCatalystコンポーネントにアクセスするための認証と認可に必要です。以下の情報が必要になります： 1. Client ID 2. Client Secret 3. Refresh Token これらの値を取得した後、アプリケーションへのPython SDKの統合に進むことができます。 <br> ### 統合手順 では、これらの値をそれぞれ取得し、コードスニペットで設定する方法を見ていきましょう。 以下に記載された手順に従ってください： 1. **Catalystコンソールでプロジェクトを作成する:** コンソールで、こちらのヘルプページに記載されている手順を使用して、新しいCatalystプロジェクトを作成できます。 2. **Project IDを取得する:** プロジェクトを作成したら、**Project ID**を控えておく必要があります。Project IDは、プロジェクトの作成時に自動的に作成されるプロジェクトの一意のIDです。 Catalystコンソールの右上にある**Settings**アイコンをクリックすると確認できます。 **Settings**画面で、**Project Settings**に移動し、**General**を選択します。以下のスクリーンショットに示すように、このセクションからProject IDを確認して控えることができます。 <br> 3. **ZAIDを取得する:** このセクションで提供されるコードスニペットに、プロジェクトの**ZAID**を含める必要があります。**ZAID**は、プロジェクトを必要なCatalyst環境（developmentまたはproduction）にリンクするためにCatalystによって割り当てられる一意のポータル識別子です。 Catalyst環境の詳細はこちら ZAIDを取得するには、Catalyst CloudScale Authenticationコンポーネントのセットアップが必須です。ただし、アプリケーションの認証フローに使用するかどうかは任意です。ZAIDを取得するには： i. コンソールでCatalyst CloudScaleサービスに移動し、**Security & Identity**の下にある**Authentication**を選択します。 <br> ii. Native Catalyst Authenticationをセットアップする必要があります。これにより、Catalystが認証プロセス全体を管理し、追加のコーディングやインフラストラクチャ管理が不要になります。 iii. **Set Up**をクリックします。 <br> iv. **Hosted authentication**タイプを選択します。これにより、アプリケーションの専用ページでログイン要素をホストできます。コンソールから認証を設定・デザインすると、Catalystがアプリケーション用にレンダリングし、すべてのバックエンド要件を処理します。 <br> v. ログインコンポーネントにサインアップ機能を表示し、新しいユーザーがアプリケーションに登録してアクセスできるようにするには、Public Signupオプションを有効にする必要があります。詳細なステップバイステップのセットアップガイドについては、ホスト認証ヘルプページを参照してください。 <br> vi. 確認画面で、**Yes, proceed**をクリックします。 <br> vii. 以下に記載されているサポートされているソーシャルログインオプションのいずれかを有効にし、選択したプロバイダーから対応する**ZAID**値を取得できます。 特定のソーシャルログインのZAIDを取得する方法はこちら 注意: Google、Microsoft、LinkedIn、FacebookなどのソーシャルログインプロバイダーはZAIDの取得に対応していますが、ZohoログインはこのZAID取得の目的には対応していません。 <br> このホスト認証タイプの詳細はこちら <br> 4. **セルフクライアントアプリケーションを登録する:** アプリケーションのユーザーに代わってCatalystリソースにアクセスするために、アプリケーションの認証と認可に必要な**Refresh Token**、**Client ID**、**Client Secret**を取得する必要があります。 上記の必要な項目を取得するには、まずAPIコンソールでアプリケーションをセルフクライアントとして登録する必要があります。 i. APIコンソールにログインし、**Self-client**をクリックします。 <br> ii. アプリケーションがCatalystで実行する必要がある操作に基づいて、セルフクライアントアプリケーションのスコープを設定します。 利用可能なスコープの詳細はこちら iii. 必要なスコープを指定し、適切な説明を追加して、**Create**をクリックします。 <br> iv. グラントトークンが生成されます。これは一度きりのプロセスであり、コンソールから再度取得することはできないため、必ずコピーして安全に保存してください。 グラントトークンの生成の詳細はこちら <br> v. **Client Secret**タブに切り替えて、Client IDとClient Secretの詳細を控えます。 <br> vi. こちらのヘルプページのリクエストを使用して、アクセストークンとリフレッシュトークンを生成できます。また、こちらのページに記載されている手順を使用して、アクセストークンを更新することもできます。 上記のすべての値を控えた後、以下に示すようにコードスニペットで設定し、Python SDKをアプリケーションに統合できます。以下のコードは、Catalyst CloudScale Stratusからバケットを取得する例で説明しています。 <br> ### コードスニペット import zcatalyst_sdk from zcatalyst_sdk import credentials from zcatalyst_sdk import types from zcatalyst_sdk.types import ICatalystOptions from flask import Flask, Request, make_response, jsonify from typing import Dict, Literal app = Flask(__name__) def list_all_buckets(): Cred = { "refresh_token": "YOUR_REFRESH_TOKEN", //ここにリフレッシュトークンを入力してください "client_id": "CLIENT_ID", //ここにクライアントIDを入力してください "client_secret": "CLIENT_SECRET", //ここにクライアントシークレットを入力してください } project_id = PROJECT_ID //ここにプロジェクトIDを入力してください project_key = ZAID //ここにZAIDを入力してください environment = "Development" //"Development"または"Production"を指定してください catalyst_credential = credentials.RefreshTokenCredential(Cred) catalyst_options = ICatalystOptions( project_id=project_id, project_key=project_key, project_domain="https://api.catalyst.zoho.com", environment=environment, ) catalystApp = zcatalyst_sdk.initialize_app( credential=catalyst_credential, options=catalyst_options, name="TaskSDKPython" ) stratus = catalystApp.stratus() buckets = stratus.list_buckets() print(buckets) return jsonify({"message": "Success", "bucket_data": buckets}) @app.route("/listbuckets", methods=["GET"]) def handle_list_all_buckets(): return list_all_buckets() if __name__ == "__main__": with app.app_context(): response = handle_list_all_buckets() port = 3006 printf("Server running on http://localhost:{port}") app.run(port=port) #### Cloud Scale ##### Data Store -------------------------------------------------------------------------------- title: "Data Storeインスタンスの取得" description: "このページでは、PythonアプリケーションでData Storeのテーブルから一括で行を削除する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.348Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/data-store/get-component-instance/" service: "Cloud Scale" related: - Data Store Help (/ja/cloud-scale/help/data-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Data Store Catalyst Cloud Scale Data Storeは、アプリケーションの永続データを格納するクラウドベースのリレーショナルデータベース管理システムです。このセクションでは、テーブルやカラムのメタデータの取得、行の詳細の取得、新しい行の挿入、行の更新、削除など、Data Storeでデータ集約型の操作を実行するために使用できるさまざまなメソッドについて説明します。 ### コンポーネントインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに関する定義済みの設定にアクセスするために使用できるオブジェクトです。このプロセスはサーバーサイドの呼び出しを発生させません。 以下のコードで使用されているappの参照は、SDK初期化時にレスポンスとして返されるPythonオブジェクトです。以下のように新しいdatastore_serviceインスタンスを作成できます。このインスタンスは、データベース固有の操作を実行する際のさまざまなシナリオで使用されることに注意してください。 #Data Storeコンポーネントインスタンスを取得する datastore_service = app.datastore() -------------------------------------------------------------------------------- title: "テーブルメタデータの取得" description: "このページでは、Pythonアプリケーションで単一テーブルまたは複数テーブルのメタデータを取得する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.348Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/data-store/get-table-meta/" service: "Cloud Scale" related: - Get Table Meta - API (/ja/api/code-reference/cloud-scale/data-store/get-table-metadata/#GetTableMetadata) - Data Store Help (/ja/cloud-scale/help/data-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # テーブルメタデータの取得 Catalyst Data Store内の単一テーブルのメタデータは、2つの方法で取得できます。以下のコードスニペットで使用されているData Store参照は、先に作成したコンポーネントインスタンスです。 ### テーブルIDによるテーブルメタデータの取得 テーブルのメタデータは、以下のようにget_table_details()メソッドで対応するtableIDを参照することで取得できます。 テーブルIDは、Data Storeから、またはコンソールでテーブルを開いた際のURLから取得できます。以下で使用されているコンポーネントインスタンスdatastore_serviceの詳細については、こちらのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>tableID</td> <td>String</td> <td>必須パラメータです。メタデータを取得するテーブルのIDを保持します。</td> </tr> </tbody> </table> #テーブルIDを使用してテーブルメタデータを取得する datastore_service = app.datastore() table_data = datastore_service.get_table_details(5249000000011745) サンプルレスポンスを以下に示します： { "project_id":{ "project_name":"AlienCity", "id":"2136000000007733" }, "table_name":"COUNTRY", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"amelia@burrows.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 01:47 PM", "column_details":[ { "table_id":"5249000000011745", "column_sequence":"1", "column_name":"ROWID", "category":1, "data_type":"bigint", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":false, "column_id":"2136000000007784" }, { "table_id":"5249000000011745", "column_sequence":"2", "column_name":"CREATORID", "category":1, "data_type":"bigint", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":true, "column_id":"2136000000007785" }, { "table_id":"5249000000011745", "column_sequence":"3", "column_name":"CREATEDTIME", "category":1, "data_type":"datetime", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":true, "column_id":"2136000000007786" }, { "table_id":"5249000000011745", "column_sequence":"4", "column_name":"MODIFIEDTIME", "category":1, "data_type":"datetime", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":true, "column_id":"2136000000007787" }, { "table_id":"5249000000011745", "column_sequence":"5", "column_name":"CITYNAME", "category":2, "data_type":"varchar", "max_length":"100", "is_mandatory":false, "decimal_digits":"2", "is_unique":true, "search_index_enabled":true, "column_id":"2136000000008588" } ], "table_id":"5249000000011745" } ### テーブル名によるテーブルメタデータの取得 以下のコードスニペットを使用して、table_nameを参照してテーブルのメタデータを取得できます。 注意： テーブルの名前を変更した場合は、該当するすべてのセクションでコードの変更を更新する必要があります。 以下で使用されているコンポーネントインスタンスdatastore_serviceの詳細については、こちらのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>table_name</td> <td>String</td> <td>必須パラメータです。メタデータを取得するテーブルの名前を保持します。</td> </tr> </tbody> </table> datastore_service = app.datastore() table_data = datastore_service.get_table_details("Aliens") サンプルレスポンスを以下に示します： { "project_id":{ "project_name":"AlienCity", "id":"2136000000007733" }, "table_name":"Aliens", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"amelia.burrows@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 01:47 PM", "column_details":[ { "table_id":"5249000000011745", "column_sequence":"1", "column_name":"ROWID", "category":1, "data_type":"bigint", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":false, "column_id":"2136000000007784" }, { "table_id":"5249000000011745", "column_sequence":"2", "column_name":"CREATORID", "category":1, "data_type":"bigint", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":true, "column_id":"2136000000007785" }, { "table_id":"5249000000011745", "column_sequence":"3", "column_name":"CREATEDTIME", "category":1, "data_type":"datetime", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":true, "column_id":"2136000000007786" }, { "table_id":"5249000000011745", "column_sequence":"4", "column_name":"MODIFIEDTIME", "category":1, "data_type":"datetime", "max_length":"50", "is_mandatory":false, "decimal_digits":"2", "is_unique":false, "search_index_enabled":true, "column_id":"2136000000007787" }, { "table_id":"5249000000011745", "column_sequence":"5", "column_name":"AlienType", "category":2, "data_type":"varchar", "max_length":"100", "is_mandatory":false, "decimal_digits":"2", "is_unique":true, "search_index_enabled":true, "column_id":"2136000000008588" } ], "table_id":"5249000000011745" } ### 全テーブルのメタデータの取得 単一テーブルのメタデータの取得に加えて、getAllTables()メソッドを使用してCatalystプロジェクト内のすべてのテーブルの詳細を取得できます。以下で使用されているコンポーネントインスタンスdatastore_serviceの詳細については、こちらのヘルプセクションを参照してください。 datastore_service = app.datastore() tables = datastore_service.get_all_tables() サンプルレスポンスを以下に示します： [ { "project_id":{ "project_name":"AlienCity", "id":"2136000000007733" }, "table_name":"Attackers", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"amelia.burrows@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 01:47 PM", "table_id":"2136000000007781" }, "table_name":"Aliens", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 01:47 PM", "table_id":"5249000000011745" } ] 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "テーブルインスタンスの取得" description: "このページでは、PythonアプリケーションでData StoreのテーブルからテーブルインスタンスをtableIDおよび名前を使用して取得する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.349Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/data-store/get-table-instance/" service: "Cloud Scale" related: - Data Store Help (/ja/cloud-scale/help/data-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # テーブルインスタンスの取得 テーブル参照は、tableIDまたはテーブル名をパラメータとして渡すことで、定義済みのData Store参照を参照して作成できます。以下のコードスニペットで使用されているdatastore_serviceの参照は、先に作成したコンポーネントインスタンスです。 ### TableIDを使用したテーブルインスタンスの取得 table_serviceの参照は、table()メソッドにtableIDをパラメータとして渡すことで作成できます。以下で使用されているコンポーネントインスタンスdatastore_serviceの詳細については、こちらのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>tableID</td> <td>String</td> <td>必須パラメータです。テーブルのIDを保持します。</td> </tr> </tbody> </table> #テーブルIDを使用してテーブルインスタンスを取得する datastore_service = app.datastore() table_service = datastore_service.table(5249000000011745) ### テーブル名を使用したテーブルインスタンスの取得 また、table()メソッドでテーブル名を参照することで、テーブル参照を作成することもできます。これらのメソッドには明示的なレスポンスはなく、テーブルのインスタンスのみが返されます。 以下で使用されているコンポーネントインスタンスdatastore_serviceの詳細については、こちらのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>table_name</td> <td>String</td> <td>必須パラメータです。テーブルの名前を保持します。</td> </tr> </tbody> </table> #テーブル名を使用してテーブルインスタンスを取得する datastore_service = app.datastore() table_service = datastore_service.table("CITY") -------------------------------------------------------------------------------- title: "カラムメタデータの取得" description: "このページでは、PythonアプリケーションでData Storeのテーブルから単一カラムまたは複数カラムのメタデータを取得する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.349Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/data-store/get-column-meta/" service: "Cloud Scale" related: - Get Column Meta - API (/ja/api/code-reference/cloud-scale/data-store/get-column-metadata/#GetColumnMetadata) - Data Store Help (/ja/cloud-scale/help/data-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # カラムメタデータの取得 Catalyst Data Storeのテーブル内の単一カラムのメタデータの詳細は、columnIDまたはカラム名を使用して取得できます。 ### IDによるカラムメタデータの取得 get_column_details()メソッドを使用して、特定のテーブルのカラムメタデータを取得できます。以下で使用されているコンポーネントインスタンスdatastore_serviceおよびテーブルインスタンスtable_serviceの詳細については、それぞれのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>columnID</td> <td>String</td> <td>必須パラメータです。メタデータを取得するカラムのIDを保持します。</td> </tr> </tbody> </table> #カラムIDを使用してカラムメタデータを取得する datastore_service = app.datastore() table_service = datastore_service.table("CITY") column_data = table_service.get_column_details(5249000000032372) サンプルレスポンスを以下に示します： { table_id: "5249000000011745", column_sequence: "5", column_name: "CITYNAME", category: 2, data_type: "varchar", max_length: "100", is_mandatory: false, decimal_digits: "2", is_unique: true, search_index_enabled: false, column_id: "5249000000032372" } ### 名前によるカラムメタデータの取得 カラムのメタデータを取得する別の方法として、column_nameを参照する方法があります。これは前の方法と同じレスポンスを返します。 カラムメタにはそれ以上の操作は含まれません。そのため、レスポンスはここで直接返されます。以下で使用されているコンポーネントインスタンスdatastore_serviceおよびテーブルインスタンスtable_serviceの詳細については、それぞれのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>column_name</td> <td>String</td> <td>必須パラメータです。メタデータを取得するカラムの名前を保持します。</td> </tr> </tbody> </table> #カラム名を使用してカラムメタデータを取得する datastore_service = app.datastore() table_service = datastore_service.table("CITY") column_data = table_service.get_column_details("CITYNAME") サンプルレスポンスを以下に示します： { table_id: "5249000000011745", column_sequence: "5", column_name: "CITYNAME", category: 2, data_type: "varchar", max_length: "100", is_mandatory: false, decimal_digits: "2", is_unique: true, search_index_enabled: false, column_id: "2305000000007725" } ### 全カラムのメタデータの取得 単一カラムのメタデータの取得に加えて、get_all_columns()メソッドを使用して特定のテーブル内のすべてのカラムのメタデータを取得できます。以下で使用されているコンポーネントインスタンスdatastore_serviceおよびテーブルインスタンスtable_serviceの詳細については、それぞれのヘルプセクションを参照してください。 #すべてのカラムのメタデータを取得する datastore_service = app.datastore() table_service = datastore_service.table("CITY") columns = table_service.get_all_columns() サンプルレスポンスを以下に示します： [ { table_id: "5249000000011745", column_sequence: "1", column_name: "ROWID", category: 1, data_type: "bigint", max_length: "50", is_mandatory: false, decimal_digits: "2", is_unique: false, search_index_enabled: false, column_id: "2136000000007784" }, { table_id: "5249000000011745", column_sequence: "2", column_name: "CREATORID", category: 1, data_type: "bigint", max_length: "50", is_mandatory: false, decimal_digits: "2", is_unique: false, search_index_enabled: true, column_id: "2136000000007785" }, { table_id: "5249000000011745", column_sequence: "3", column_name: "CREATEDTIME", category: 1, data_type: "datetime", max_length: "50", is_mandatory: false, decimal_digits: "2", is_unique: false, search_index_enabled: true, column_id: "2136000000007786" }, { table_id: "5249000000011745", column_sequence: "4", column_name: "MODIFIEDTIME", category: 1, data_type: "datetime", max_length: "50", is_mandatory: false, decimal_digits: "2", is_unique: false, search_index_enabled: true, column_id: "2136000000007787" }, { table_id: "5249000000011745", column_sequence: "5", column_name: "CITYNAME", category: 2, data_type: "varchar", max_length: "100", is_mandatory: false, decimal_digits: "2", is_unique: true, search_index_enabled: true, column_id: "2136000000008588" } ] 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "行の取得" description: "このページでは、PythonアプリケーションでData Storeのテーブルから単一行またはすべての行を取得する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.349Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/data-store/get-rows/" service: "Cloud Scale" related: - Get Rows - API (/ja/api/code-reference/cloud-scale/data-store/get-all-rows/#GetAllRows) - Data Store Help (/ja/cloud-scale/help/data-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # 行の取得 Catalyst Data Storeのテーブルから単一行または複数行のデータを取得できます。これらのコードスニペットで使用されているtable_serviceの参照は、テーブルインスタンスまたはテーブルメタのいずれかです。 ### 単一行の取得 get_row()メソッドを使用して、テーブルから単一行を取得できます。以下のコードスニペットに示すように、このメソッドに行の一意のRowIDを渡す必要があります。以下で使用されているコンポーネントインスタンスdatastore_serviceおよびテーブルインスタンスtable_serviceの詳細については、それぞれのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>rowID</td> <td>String</td> <td>必須パラメータです。詳細を取得する行のIDを格納します。</td> </tr> </tbody> </table> # 1行を取得する datastore_service = app.datastore() table_service = datastore_service.table("CITY") row_data = table_service.get_row(5249000000032385) サンプルレスポンスを以下に示します： { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-17 13:02:11:184", CREATEDTIME: "2021-08-16 16:29:10:499", CITYNAME: "Pune", ROWID: "5249000000032385" } ### ページネーションによる全行の取得 get_paged_rows()関数を使用してコードにページネーションを組み込むことで、Data Storeのテーブルからすべての行のデータを取得できます。ページネーションにより、イテレーションを通じてテーブルの行をバッチまたはページ単位で取得できます。 このイテレーションは、以下のコードに示すように、すべての行が取得されるまで実行されます。これは単純なif条件で検証されます。テーブルは一意のテーブル名で参照できます。 たとえば、行を100件ずつのバッチで個別のページとして取得する場合、各ページで取得する最大行数の変数を定義してカウントを指定できます。以下のサンプルコードではmax_rowsを100に設定しています。 注意： maxRowsパラメータは任意です。この値が指定されない場合、SDK呼び出しはデフォルトで1ページあたり200行を返します。 さらに、レスポンスデータに後続のデータ取得を認可するトークン文字列が含まれます。このトークンはnext_tokenを通じて取得でき、以下のコードに示すように、後続のイテレーション時にnext_tokenの値として渡します。ループの最初の実行時、next_token文字列の値はNoneに設定されます。次のレコードセットは、レスポンスデータのmore_recordsを通じて取得されます。 注意： ページネーションはNode.js SDK v2.1.0アップデートから利用可能になりました。Node.js SDKの旧バージョンでは利用できません。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>next_token</td> <td>String</td> <td>必須パラメータです。後続のデータ取得を認可するレスポンスデータからのトークンを格納します。</td> </tr> <tr> <td>max_rows</td> <td>Numeric</td> <td>任意パラメータです。行を取得するバッチの数を保持します。</td> </tr> </tbody> </table> datastore_service = app.datastore() table_service = datastore_service.table("Aliens") def getMyPagedRows(next_token=None, more_records=True): rows = table_service.get_paged_rows(next_token, max_rows=100) more_records = rows['more_records'] if not more_records: return None next_token = rows['next_token'] return getMyPagedRows(next_token, more_records) getMyPagedRows() more_recordsパラメータがtrueに設定されている場合、サンプルレスポンスを以下に示します： { "status": 200, "content": [ { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:24:855", "CITYNAME": "New York", "CREATEDTIME": "2022-01-11 18:18:24:855", "ROWID": "5249000000032385" }, { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:25:117", "CITYNAME": "Houston", "CREATEDTIME": "2022-01-11 18:18:25:117", "ROWID": "5249000000032386" }, { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:25:120", "CITYNAME": "Chicago", "CREATEDTIME": "2022-01-11 18:18:25:120", "ROWID": "5249000000032387" } ], "message": "OK", "more_records": true, "next_token": "{{token}}" } more_recordsパラメータがfalseに設定されている場合、サンプルレスポンスを以下に示します： { "status": 200, "content": [ { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:43:556", "name": "San Diego", "CREATEDTIME": "2022-01-11 18:18:43:556", "ROWID": "5249000000032385" }, { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:43:557", "name": "Phoenix", "CREATEDTIME": "2022-01-11 18:18:43:557", "ROWID": "5249000000032386" }, { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:43:568", "name": "Seattle", "CREATEDTIME": "2022-01-11 18:18:43:568", "ROWID": "5249000000032387" } ], "message": "OK", "more_records": false } 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "行の挿入" description: "このページでは、PythonアプリケーションでData Storeのテーブルに単一行または複数行を一括挿入するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.349Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/data-store/insert-rows/" service: "Cloud Scale" related: - Insert Rows - API (/ja/api/code-reference/cloud-scale/data-store/insert-new-row/#InsertNewRow) - Data Store Help (/ja/cloud-scale/help/data-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # 行の挿入 テーブルの一意のIDまたは名前を参照して、Catalyst Data Storeのテーブルに新しい行を挿入できます。次のセクションで説明するように、テーブルに複数の行を挿入することもできます。 以下のコードで使用されているtable_service参照は、以前に作成されたテーブルインスタンスまたはテーブルメタのいずれかです。 注意： * テーブルとその中のカラムは事前に作成されている必要があります。コンソールからテーブルを作成し、カラムを作成できます。 * 開発環境では、各プロジェクトの各テーブルに最大5000件のレコードを挿入できます。開発環境では、各プロジェクト全体で最大25,000件のレコードを作成できます。本番環境ではレコード作成の上限はありません。 ### 単一行の挿入 以下に示すように、行の詳細を{カラム名 : カラム値}形式で含む辞書を作成し、それをinsert_row()メソッドの引数として渡す必要があります。これにより、一意のテーブル名またはテーブルIDで参照するテーブルに行が挿入されます。 行が挿入されると、一意のID値が自動的に生成されます。以下で使用されているコンポーネントインスタンスdatastore_serviceとテーブルインスタンスtable_serviceの詳細については、それぞれのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>row_data</td> <td>Array</td> <td>必須パラメータです。挿入する行の詳細をキーと値のペアで保持します。</td> </tr> </tbody> </table> #テーブルに単一行を挿入する datastore_service = app.datastore() table_service = datastore_service.table("Employee") row_data = {'name': 'George Hamilton', 'id': '6868', 'age': '22'} row_response = table_service.insert_row(row_data) サンプルレスポンスを以下に示します： { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-16 16:30:12:799", Name: "George Hamilton", Age: 22, ID: 6868, CREATEDTIME: "2021-08-16 16:30:12:799", ROWID: "2136000000011015" } ### 複数行の挿入 以下に示すように、行を含む配列を構築し、それをinsert_rows()メソッドの引数として渡すことで、テーブルに複数の行を挿入できます。以下で使用されているコンポーネントインスタンスdatastore_serviceとテーブルインスタンスtable_serviceの詳細については、それぞれのヘルプセクションを参照してください。 行オブジェクトの配列を含むレスポンスが返されます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w60p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>row_data</td> <td>Array</td> <td>必須パラメータです。挿入する行の詳細をキーと値のペアで保持します。</td> </tr> </tbody> </table> datastore_service = app.datastore() table_service = datastore_service.table("Employee") row_data = [{'name': 'Mark Wellington', 'id': '7218', 'age': '29'}, {'name': 'Zendaya Jones', 'id': '3211', 'age': '32'}] row_response = table_service.insert_rows(row_data) サンプルレスポンスを以下に示します： [ { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-25 13:55:04:904", Name: "Mark Wellington", Age: 29, ID: 7218, CREATEDTIME: "2021-08-25 13:55:04:904", ROWID: 2136000000011015 }, { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-25 13:55:04:906", Name: "Zendaya Jones", Age: 32, ID: 3211, CREATEDTIME: "2021-08-25 13:55:04:906", ROWID: 2136000000011016 } ] 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "行の更新" description: "このページでは、PythonアプリケーションでData Storeのテーブルの単一行または複数行を一括更新するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.349Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/data-store/update-rows/" service: "Cloud Scale" related: - Update Rows - API (/ja/api/code-reference/cloud-scale/data-store/update-row/#UpdateRow) - Data Store Help (/ja/cloud-scale/help/data-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # 行の更新 Catalyst Data Storeのテーブルで、単一行または複数行を更新できます。以下のコードスニペットで使用されているtable_service参照は、以前に作成されたテーブルインスタンスまたはテーブルメタのいずれかです。 ### 単一行の更新 このメソッドでは、必要なカラムに変更後の値を含むオブジェクトを構築して、単一行を更新できます。 一意のROWIDを参照し、更新された行の詳細を含む新しく構築されたオブジェクトをupdate_row()メソッドに渡します。ここではROWID値の指定が必須であることに注意してください。以下で使用されているコンポーネントインスタンスdatastore_serviceとテーブルインスタンスtable_serviceの詳細については、それぞれのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>row_data</td> <td>Array</td> <td>必須パラメータです。更新する行の詳細をキーと値のペアで保持します。</td> </tr> </tbody> </table> #単一行を更新する datastore_service = app.datastore() table_service = datastore_service.table("table_name") row_data = {'name': 'Mathew Jones', 'id': '7211', 'age': '31', 'ROWID': 2136000000011011} row_response = table_service.update_row(row_data) logging.info(row_response) サンプルレスポンスを以下に示します： { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-17 13:02:11:184", CREATEDTIME: "2021-08-16 16:29:10:499", Name: "Mathew Jones", ID : "7211", Age: 31, ROWID: "2136000000011011" } ### 複数行の更新 複数行を更新するには、変更後の行の値を含むオブジェクトの配列を構築し、update_rows() メソッドの引数として渡します。ROWIDは対応する配列オブジェクト内で、変更が必要な特定の行を参照するために使用されます。以下で使用されているコンポーネントインスタンスdatastore_serviceとテーブルインスタンスtable_serviceの詳細については、それぞれのヘルプセクションを参照してください。 ここで返されるレスポンスは、行オブジェクトの配列に解決されます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>row_data</td> <td>Array</td> <td>必須パラメータです。更新する行の詳細をキーと値のペアで保持します。</td> </tr> </tbody> </table> #複数行を更新する datastore_service = app.datastore() table_service = datastore_service.table("Employee") row_data = [{'name': 'Mathew Jones', 'id': '7211', 'age': '31', 'ROWID': 2136000000034043}, {'name': 'Rhonda Watson', 'id': '7212', 'age': '28', 'ROWID': 2136000000034045}] row_response = table_service.update_rows(row_data) サンプルレスポンスを以下に示します： [ { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-24 13:22:14:718", CREATEDTIME: "2021-08-24 13:12:55:999", Name: "Mathew Jones", ID : "7211", Age: 31, ROWID: "2136000000034043" }, { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-24 13:22:14:728", CREATEDTIME: "2021-08-24 13:12:56:001", Name: "Rhonda Watson", ID : "7212", Age: 28, ROWID: "2136000000034045" } ] 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "行の削除" description: "このページでは、PythonアプリケーションでData Storeのテーブルから単一行を削除するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.349Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/data-store/delete-row/" service: "Cloud Scale" related: - Delete Row - API (/ja/api/code-reference/cloud-scale/data-store/delete-row/#DeleteRow) - Data Store Help (/ja/cloud-scale/help/data-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # 行の削除 ROWIDをパラメータとしてdelete_row()メソッドに渡すだけで、テーブルから行を削除できます。このメソッドは、行の削除時にレスポンスとしてtrueを返します。 以下で使用されているコンポーネントインスタンスdatastore_serviceとテーブルインスタンスtable_serviceの詳細については、それぞれのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>ROWID</td> <td>String</td> <td>必須パラメータです。削除する行のIDを保持します。</td> </tr> </tbody> </table> #行を削除する datastore_service = app.datastore() table_service = datastore_service.table("CITY") row_response = table_service.delete_row(5249000000032461) 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "行の一括読み取り" description: "このページでは、PythonアプリケーションでData Storeのテーブルから行を一括読み取りするメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.350Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/data-store/bulk-read-rows/" service: "Cloud Scale" related: - Data Store Help (/ja/cloud-scale/help/data-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # 行の一括読み取り Catalystでは、Data Storeに存在する特定のテーブルに対して一括読み取りジョブを実行できます。 以下のSDKスニペットでは、一括読み取りジョブが特定のテーブルから数千件のレコードを読み取り、ジョブが成功した場合に読み取り操作の結果を含むCSVファイルを生成します。テーブルは一意のTable IDで参照されます。 以下で使用されているコンポーネントインスタンスdatastore_serviceの詳細については、こちらのヘルプセクションを参照してください。 <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>criteria</td> <td>Array</td> <td>必須パラメータです。行を読み取る条件を保持します。</td> </tr> <tr> <td>page</td> <td>Numeric</td> <td>必須パラメータです。読み取るページ行数を保持します。</td> </tr> <tr> <td>select_columns</td> <td>Array</td> <td>必須パラメータです。読み取る特定のカラムを保持します。</td> </tr> </tbody> </table> 特定のテーブルに対して一括読み取りジョブを実行するには、以下のSDKスニペットをコピーしてください。 #一括読み取り datastore_service = app.datastore() bulk_read = datastore_service.table("sampleTable").bulk_read() #一括読み取りジョブを作成する bulk_read_Job = bulk_read.create_job({ "criteria": { "group_operator": 'or', "group": [ { "column_name": 'Department', "comparator": 'equal', "value": 'Marketing' }, { "column_name": 'EmpId', "comparator": 'greater_than', "value": '1000' }, { "column_name": 'EmpName', "comparator": 'starts_with', "value": 'S' } ] }, "page": 1, "select_columns": ['EmpId', 'EmpName', 'Department'] }) #一括読み取りステータスを取得する status = bulk_read.get_status(bulk_read_Job['job_id']) #一括読み取り結果を取得する result = bulk_read.get_result(bulk_read_Job['job_id']) <br /> 注意： 最大200,000行を同時に読み取ることができます。 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "行の一括書き込み" description: "このページでは、PythonアプリケーションでData Storeのテーブルに行を一括書き込みするメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.350Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/data-store/bulk-write-rows/" service: "Cloud Scale" related: - Data Store Help (/ja/cloud-scale/help/data-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # 行の一括書き込み Catalystでは、Data Storeに存在する特定のテーブルに対して一括書き込みジョブを実行できます。一括書き込み操作は、StratusにアップロードされたCSVファイルから数千件のレコードを取得し、特定のテーブルに挿入します。 テーブルは、作成時にCatalystが生成する一意のtable IDで参照されます。書き込み操作を実行するカラムは、一意のcolumn IDで参照されます。 注意： 一括書き込み操作を実行するには、まず必要なデータをCSVファイルとしてStratusにアップロードする必要があります。 <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>tableID</td> <td>String</td> <td>必須パラメータです。データを書き込むテーブルのIDを保持します。</td> </tr> <tr> <td>find_by</td> <td>String</td> <td>必須パラメータです。データを書き込むカラムの名前を保持します。</td> </tr> <tr> <td>fk_mapping</td> <td>Array</td> <td>必須パラメータです。local_columnとreference_columnの詳細を保持します。</td> </tr> <tr> <td>operation</td> <td>String</td> <td>必須パラメータです。このパラメータの値はinsertである必要があります。</td> </tr> <tr> <td>object_details</td> <td>JSON Object</td> <td> <ul> <li>bucket_name: オブジェクトが保存されているバケットの名前です。</li> <li>object_key: 必要なオブジェクトのパスまたはオブジェクトURLを含めることができます。</li> <li>version_id: バケットでバージョニングが有効な場合、この属性にファイルの特定のバージョンIDが格納されます。</li> </ul> </td> </tr> </tbody> </table> 特定のテーブルに対して一括書き込みジョブを実行するには、以下のSDKスニペットをコピーしてください。以下で使用されているコンポーネントインスタンスdatastore_serviceの詳細については、こちらのヘルプセクションを参照してください。 datastore_service = app.datastore() bulk_write = datastore_service.table("Sample").bulk_write() object_details = { "bucket_name": "zcstratus12345", "object_key": "sample.csv", "version_id": "64832huidksnd83" } #バルク書き込みジョブを作成する bulk_write_job = bulk_write.create_job(object_details, { "find_by": "S1", "fk_mapping": [ {"local_column": "EmployeeID", "reference_column": "EmpId"}, {"local_column": "DepartmentID", "reference_column": "DepId"} ], "operation": "insert" }) #バルク書き込みのステータスを取得する status = bulk_write.get_status('6759000000167103') #バルク書き込みの結果を取得する result = bulk_write.get_result('6759000000167103') <br /> 注意： 一度に最大100,000行を書き込むことができます。 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "行の一括削除" description: "このページでは、PythonアプリケーションでData Storeのテーブルから行を一括削除するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.350Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/data-store/bulk-delete-rows/" service: "Cloud Scale" related: - Data Store Help (/ja/cloud-scale/help/data-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # 行の一括削除 Catalystでは、Catalyst Data Storeの特定のテーブルから行を一括削除できます。テーブルは一意のテーブルIDまたはテーブル名で参照されます。テーブルIDはData Storeから、またはコンソールでテーブルを開いた際のURLから取得できます。 一括削除操作では、1回の操作で最大200行を削除できます。以下のサンプルコードに示すように、削除する行の一意のROWIDを配列で渡すことができます。以下のコードスニペットには、少なくとも1つのROWIDを含める必要があり、最大200個のROWIDを含めることができます。 行はサンプルコードでdatastore_serviceインスタンスを通じてdelete_rows()関数に渡されます。テーブル名またはテーブルIDはtable()メソッドのパラメータとして渡す必要があります。レスポンスは削除のステータスに基づいてブール値（trueまたはfalse）を返します。 以下で使用されているコンポーネントインスタンスdatastore_serviceとテーブルインスタンスtable_serviceの詳細については、それぞれのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>ROWID</td> <td>String</td> <td>必須パラメータです。削除するROWIDを保持します。</td> </tr> </tbody> </table> #行を一括削除する datastore_service = app.datastore() table_service = datastore_service.table("sampleTable") row_response = table_service.delete_rows([6759000000159113, 6759000000159115, 5249000000032411]) 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 ##### File Store -------------------------------------------------------------------------------- title: "File Store インスタンスの取得" description: "このページでは、PythonアプリケーションでFile Storeからフォルダを削除するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.350Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/file-store/get-component-instance/" service: "Cloud Scale" related: - File Store Help (/ja/cloud-scale/help/file-store/introduction) -------------------------------------------------------------------------------- # File Store 注意： Catalystでは、早期アクセスモードでStratusという新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 Catalyst File Storeは、Catalystアプリケーションのアプリケーションファイルとユーザーデータファイルのクラウドストレージソリューションを提供し、共有データへのアクセスを可能にします。画像、動画、テキストファイル、ドキュメントファイル、スプレッドシート、その他の形式のファイルを保存、管理、整理できます。 ### コンポーネントインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに固有の事前定義された設定にアクセスするために使用できるオブジェクトです。この処理はサーバーサイドの呼び出しを発行しません。また、このコンポーネントインスタンスは、CatalystアプリケーションでFile Storeコンポーネントを使用する際の複数のシナリオで使用されることに注意してください。 以下のコードで使用されているapp参照は、SDK初期化時にレスポンスとして返されるPythonオブジェクトです。以下に示すように、新しいfilestore_serviceインスタンスを作成できます： #File Storeコンポーネントインスタンスを取得する filestore_service = app.filestore() -------------------------------------------------------------------------------- title: "フォルダインスタンスの取得" description: "このページでは、PythonアプリケーションでFile Storeからフォルダインスタンスを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.350Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/file-store/get-folder-instance/" service: "Cloud Scale" related: - File Store Help (/ja/cloud-scale/help/file-store/introduction) -------------------------------------------------------------------------------- # フォルダインスタンスの取得 注意： Catalystでは、早期アクセスモードでStratusという新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 以下で使用されているコンポーネントインスタンスfilestore_serviceの詳細については、こちらのヘルプセクションを参照してください。 #フォルダインスタンスを取得する filestore_service = app.filestore() folder_service = filestore_service.folder(5249000000016011) -------------------------------------------------------------------------------- title: "フォルダ詳細の取得" description: "このページでは、PythonアプリケーションでFile Storeからフォルダの詳細を取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.350Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/file-store/retrieve-folder-details/" service: "Cloud Scale" related: - Retrieve Folder Details - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-file/#GetSpecificFile) - File Store Help (/ja/cloud-scale/help/file-store/introduction/) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # フォルダ詳細の取得 注意： Catalystでは、早期アクセスモードでStratusという新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 Catalyst File Storeで作成されたフォルダの詳細を取得できます。単一のフォルダ、またはFile Storeにあるすべてのフォルダの詳細を取得できます。 以下で使用されているコンポーネントインスタンスfilestore_serviceの詳細については、こちらのヘルプセクションを参照してください。 ### 単一フォルダの詳細取得 このメソッドは、get_folder_details()メソッドを呼び出して、一意のフォルダIDで参照される特定のフォルダの詳細を取得します。フォルダIDはData Storeから、またはコンソールでフォルダを開いた際のURLから取得できます。 このメソッドのレスポンスとして、フォルダのメタ詳細が返されます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>file_ID</td> <td>String</td> <td>必須パラメータです。詳細を取得するフォルダのIDを保持します。</td> </tr> </tbody> </table> #単一フォルダの詳細を取得する filestore_service = app.filestore() data = filestore_service.get_folder_details(5249000000016011) サンプルレスポンスを以下に示します： { "folder_name":"Store_Data", "created_time":"Aug 13, 2021 05:32 PM", "created_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"amelia.burrows@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 05:32 PM", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"amelia.burrows@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "project_details":{ "project_name":"ShipmentTracking", "id":"2136000000007733", "project_type":"Live" }, "file_details":[ { "id":"2136000000020111", "file_location":null, "file_name":"Img.jpeg", "file_size":"84881", "created_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"p.boyle@zylker.com", "first_name":"Patricia", "last_name":"Boyle", "user_type":"Admin", "user_id":"2136000000006767" }, "created_time":"Aug 17, 2021 09:32 PM", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"p.boyle@zylker.com", "first_name":"Patricia", "last_name":"Boyle", "user_type":"Admin", "user_id":"2136000000006767" }, "modified_time":"Aug 17, 2021 09:32 PM", "project_details":{ "project_name":"ShipmentTracking", "id":"2136000000007733", "project_type":"Live" }, "folder_details":"5249000000016011" } ], "id":"2136000000008551" } ### すべてのフォルダの詳細取得 get_all_folders()メソッドを使用して、Catalystアプリケーション内のすべてのフォルダの詳細を取得できます。 このメソッドのレスポンスとして、フォルダのメタ詳細の配列が返されます。 #すべてのフォルダの詳細を取得する filestore_service = app.filestore() data = filestore_service.get_all_folders() サンプルレスポンスを以下に示します： [ { "folder_name":"Invoices", "created_time":"Aug 25, 2021 11:38 AM", "created_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 25, 2021 11:38 AM", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "project_details":{ "project_name":"ShipmentTracking", "id":"2136000000007733", "project_type":"Live" }, "id":"2136000000037021" }, { "folder_name":"Store_Data", "created_time":"Aug 13, 2021 05:32 PM", "created_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 05:32 PM", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "project_details":{ "project_name":"ShipmentTracking", "id":"2136000000007733", "project_type":"Live" }, "id":"2136000000008551" } ] 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "ファイルのアップロード" description: "このページでは、PythonアプリケーションでFile Storeのフォルダにファイルをアップロードするメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.351Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/file-store/upload-file/" service: "Cloud Scale" related: - Upload File - API (/ja/api/code-reference/cloud-scale/file-store/upload-file-in-folder/#UploadFileInaFolder) - File Store Help (/ja/cloud-scale/help/file-store/introduction/) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # ファイルのアップロード 注意： Catalystでは、早期アクセスモードでStratusという新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 一意のフォルダIDを参照して、ローカルシステムからCatalyst File Storeの既存のフォルダにファイルをアップロードできます。画像、テキストドキュメント、CSV、その他必要な種類のファイルをアップロードできます。 アップロードできるファイルの最大サイズは100 MBです。ファイルがアップロードされた後、一意のファイルIDが作成されます。 注意： Catalystは、開発環境の各プロジェクトに1 GBのFile Storeスペースを提供しています。本番環境ではストレージの上限はありません。 以前に作成されたコンポーネント参照またはフォルダ参照のいずれかを使用して、ファイルをアップロードするフォルダを参照できます。フォルダの一意のフォルダIDを渡す必要があります。ここで返されるレスポンスは、アップロードされたファイルの情報です。 以下で使用されているコンポーネントインスタンスfilestore_serviceの詳細については、こちらのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>file_name</td> <td>String</td> <td>必須パラメータです。File Storeにアップロードするファイルの名前を保持します。</td> </tr> <tr> <td>content_type</td> <td>File</td> <td>必須パラメータです。デフォルト値として「file」を保持します。</td> </tr> </tbody> </table> #ファイルをアップロードする file = open('file.txt', "rb") filestore_service = app.filestore() folder = filestore_service.folder(6759000000166049) folder.upload_file('testFile.txt',file) サンプルレスポンスを以下に示します： { id: "5249000000016011", file_location: null, file_name: "testFile.txt", file_size: "84881", created_by: { zuid: "66466723", is_confirmed: false, email_id: "amelia.burrows@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: "2136000000006003" }, created_time: "Aug 17, 2021 09:33 PM", modified_by: { zuid: "66466723", is_confirmed: false, email_id: "amelia.burrows@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: "2136000000006003" }, modified_time: "Aug 17, 2021 09:33 PM", project_details: { project_name: "ShipmentTracking", id: "2136000000007733" }, folder_details: "5249000000016011" } 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "フォルダからファイルのダウンロード" description: "このページでは、PythonアプリケーションでFile Storeのフォルダからファイルをダウンロードするメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.351Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/file-store/download-a-file-from-the-folder/" service: "Cloud Scale" related: - Download File from Folder - API (/ja/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder) - File Store Help (/ja/cloud-scale/help/file-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # フォルダからファイルをダウンロード 注意： Catalystでは、早期アクセスモードでStratusという新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 一意のファイルIDを参照して、フォルダからファイルをダウンロードできます。以下で使用されているコンポーネントインスタンスfilestore_serviceとフォルダインスタンスfolder_serviceの詳細については、それぞれのヘルプセクションを参照してください。 ファイルIDはdownload_file()メソッドの引数として渡されます。このメソッドは、レスポンスとしてBytes形式のテキストファイルを返します。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>file_ID</td> <td>String</td> <td>必須パラメータです。ダウンロードするファイルのIDを保持します。</td> </tr> </tbody> </table> #ファイルをダウンロードする filestore_service = app.filestore() folder_service = filestore_service.folder(5249000000016011) data = folder_service.download_file(5249000000032063) 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "ファイルの削除" description: "このページでは、PythonアプリケーションでFile Storeからフォルダを削除するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.351Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/file-store/delete-a-file/" service: "Cloud Scale" related: - Delete a File - API (/ja/api/code-reference/cloud-scale/file-store/delete-file/#DeleteFile) - File Store Help (/ja/cloud-scale/help/file-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # ファイルの削除 注意： Catalystでは、早期アクセスモードでStratusという新しいオブジェクトストレージコンポーネントを提供しています。このコンポーネントは、現在のCloud Scale File Storeコンポーネントの大幅なアップグレードです。Stratusコンポーネントの詳細については、こちらをご覧ください。<br /><br />早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。 ファイルIDを参照して、フォルダからファイルを削除できます。以下のコードスニペットでは、コンポーネント参照またはフォルダ参照が使用されています。ファイルIDはdelete_file()メソッドのパラメータとして渡されます。レスポンスは削除のステータスに基づいてブール値（trueまたはfalse）を返します。 以下で使用されているコンポーネントインスタンスfilestore_serviceとフォルダインスタンスfolder_serviceの詳細については、それぞれのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>file_ID</td> <td>String</td> <td>必須パラメータです。削除するファイルのIDを保持します。</td> </tr> </tbody> </table> #ファイルを削除する filestore_service = app.filestore() folder_service = filestore_service.folder(5249000000016011) folder_service.delete_file(5249000000032063) 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 ##### NoSQL -------------------------------------------------------------------------------- title: "コンポーネントインスタンスの取得" description: "Catalyst NoSQLは、非リレーショナル・非SQLのデータストレージ手段を提供する、完全マネージドで強力なデータベースです。このページでは、新しいNoSQLコンポーネントインスタンスを作成するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.351Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/nosql/get-component-instance/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/insert-item/#InsertNewItem) - NoSQL Java SDK (/ja/sdk/java/v1/cloud-scale/nosql/get-table-metadata/) - NoSQL Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/nosql/get-component-instance/) -------------------------------------------------------------------------------- # コンポーネントインスタンスの取得 Catalyst NoSQLは、アプリケーションの半構造化データ、非構造化データ、および異種データを格納できる、完全マネージドの非リレーショナルNoSQLデータストレージ機能です。Catalystは、キーと値のペアベースのJSON形式でのドキュメント型データストレージをサポートしています。 Catalyst NoSQL Python SDKパッケージを使用すると、プロジェクト内のNoSQLテーブルに対してCRUDデータ操作を実行できます。NoSQLテーブルのメタデータを取得したり、さまざまなサポートされるデータ型のNoSQLアイテムを作成したり、特定のテーブルでアイテムの挿入、更新、取得、または削除を行うことができます。クエリ条件を指定して、テーブルやテーブルのインデックスをクエリすることもできます。 ### NoSQLインスタンスの作成 コンポーネントインスタンスは、特定のコンポーネントに固有の事前定義された設定にアクセスするために使用できるオブジェクトです。 以下に示すように、PythonでSDK操作を実行するためのNoSQLオブジェクトを作成できます。これはサーバーサイドの呼び出しを発行しません。このnosqlインスタンスは、NoSQLを操作するさまざまなコードスニペットで参照します。 NoSQLインスタンスの作成に使用されるapp参照は、SDK初期化時にレスポンスとして返されるPythonオブジェクトです。 #NoSQLインスタンスを作成する nosql = app.nosql() -------------------------------------------------------------------------------- title: "テーブルメタデータの取得" description: "Catalyst NoSQLは、非リレーショナル・非SQLのデータストレージ手段を提供する、完全マネージドで強力なデータベースです。このページでは、NoSQLテーブルのメタデータを取得するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.351Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/nosql/get-table-metadata/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Create and Manage Tables (/ja/cloud-scale/help/nosql/create-manage-tables/) -------------------------------------------------------------------------------- # NoSQLテーブルメタデータの取得 以下に説明するように、単一のCatalyst NoSQLテーブル、またはプロジェクト内のすべてのテーブルのメタデータを取得できます。 ### 単一テーブルのメタデータ取得 Catalyst NoSQLの単一テーブルのメタデータは、以下に示すようにgetTable()メソッドを使用してテーブル名を参照することで取得できます。レスポンスには、パーティションキーとソートキー、TTL属性などのテーブル設定の詳細が含まれます。 以下のコードスニペットで使用されているnosql参照は、これらの操作を実行するために作成されたコンポーネントインスタンスです。 # NoSQLインスタンスを作成する nosql = app.nosql() #テーブル名を使用してテーブルメタデータを取得する table_details = nosql.get_table_resources("EmpTable") print(table_details) 注意： テーブル名を変更した場合は、コード内の変更を更新する必要があります。 <br> ### すべてのテーブルのメタデータ取得 Catalystでは、以下に示すようにget_all_tables()メソッドを使用して、プロジェクト内のすべてのテーブルのメタデータを取得できます。 table_res = nosql.get_all_tables() print(table_res) -------------------------------------------------------------------------------- title: "テーブルインスタンスの取得" description: "Catalyst NoSQLは、非リレーショナル・非SQLのデータストレージ手段を提供する、完全マネージドで強力なデータベースです。このページでは、NoSQLテーブルインスタンスを作成するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.351Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/nosql/get-table-instance/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Create and Manage Tables (/ja/cloud-scale/help/nosql/create-manage-tables/) -------------------------------------------------------------------------------- # NoSQLテーブルインスタンスの取得 Catalyst NoSQLでは、NoSQLテーブルの空のテーブルインスタンスを取得できます。このインスタンスを使用して、そのテーブルを参照し、サポートされているすべてのテーブル操作を実行できます。この処理はサーバーサイドの呼び出しを発行しません。 このセクションに示すように、テーブルの名前を参照してNoSQLテーブルのインスタンスを取得できます。以下のコードスニペットで使用されているnosql参照は、以前に作成されたコンポーネントインスタンスです。 table = nosql.get_table('employees') # テーブル名でテーブルインスタンスを作成する -------------------------------------------------------------------------------- title: "アイテムの構築" description: "Catalyst NoSQLは、非リレーショナル・非SQLのデータストレージ手段を提供する、完全マネージドで強力なデータベースです。このページでは、さまざまなデータ型のNoSQLアイテムを構築するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.351Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/nosql/construct-item/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Basic Components (/ja/cloud-scale/help/nosql/components/#basic-components) - Supported Data Types in NoSQL (/ja/cloud-scale/help/nosql/working-with-data/introduction/) -------------------------------------------------------------------------------- # NoSQLアイテムの構築 Catalyst NoSQLのアイテムは、レコードのような単一のデータポイントのデータを保持する属性のコレクションを表します。プロジェクト内の既存のNoSQLテーブルに、カスタムJSON形式でアイテムを挿入または更新できます。ただし、Catalystでアイテムを挿入または更新する前に、アイテムを構築する必要があります。 以下のセクションで説明するように、Catalystがサポートするさまざまなデータ型の属性を含むNoSQLアイテムを構築できます。CatalystはString、Number、Set of Strings、Set of Numbers、List、Mapなどのさまざまなデータ型をサポートしています。詳細については、サポートされるデータ型の完全なリストを参照してください。 テーブルに設定したパーティションキー属性の値は、すべてのデータアイテムで必ず提供する必要があります。テーブルキー、TTL属性、その他の詳細については、テーブルキーのヘルプセクションを参照してください。 以下のコードスニペットは、さまざまなデータ型の属性を持つアイテムを構築する形式を示しています： # 異なるデータ型のNoSQLアイテムを構築する attributes = { # 文字列 "custom_attrib_string": { "S": "John Doe" }, # 数値 "custom_attrib_num": { "N": "234521" }, # バイナリエンコード値 "custom_attrib_bin": { "B": "SGVsbG9Xb3JsZA==" }, # 文字列のセット "custom_attrib_set_string": { "SS": ["John Doe", "New York", "USA"] }, # 数値のセット "custom_attrib_set_num": { "SN": ["23423", "821n", "11"] }, # バイナリ値のセット "custom_attrib_set_bin": { "SB": ["SGVsbG8=", "V29ybGQ="] }, # ブール属性 "custom_attrib_bool": { "BOOL": True }, # リスト属性 "custom_attrib_list": { "L": [{"name": "banana"}, {"quantity": 4}] }, # マップ属性 "custom_attrib_map": { "M": { "name": { "S": "John Doe" }, "age": { "N": "23" } } } } -------------------------------------------------------------------------------- title: "アイテムの挿入" description: "Catalyst NoSQLは、非リレーショナル・非SQLのデータストレージ手段を提供する、完全マネージドで強力なデータベースです。このページでは、NoSQLテーブルにさまざまな方法でアイテムを挿入するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.352Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/nosql/insert-items/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Working with Data (/ja/cloud-scale/help/nosql/working-with-data/introduction/) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/insert-item/#InsertNewItem) -------------------------------------------------------------------------------- # NoSQLテーブルへのアイテム挿入 Catalystでは、アイテムを構築した後、特定のNoSQLテーブルにアイテムを挿入できます。このセクションで説明するように、アイテムはさまざまな方法で挿入できます。 データの追加と操作、CatalystカスタムJSON形式、およびサポートされるデータ型に関するヘルプセクションを参照して、これらのトピックを詳しく学ぶことができます。 注意： Catalystでは、1回のSDK操作でNoSQLテーブルに最大25アイテムを一括挿入できます。 <br> ### 条件なしのアイテム挿入 CatalystカスタムJSON形式でアイテムを構築することにより、条件なしでNoSQLテーブルに新しいアイテムを挿入できます。これには、テーブルに設定されたパーティションキーとソートキー属性の値を必ず渡す必要があります。 たとえば、以下のコードスニペットでは、アイテムのパーティションキーとソートキー属性であるfruitNameとLocationの値がそれぞれ提供されています。fruitTypeやavailabilityなどのString型の他の属性は、リストfruitPropertiesとして提供されています。アイテムはinsert_items()メソッドを使用して挿入されます。 # 条件なしでNoSQLアイテムを挿入する item = { "fruitName": { "S": "Banana" }, "Location": { "S": "Indonesia" }, "fruitProperties": { "L": [ { "fruitType": "Berries" }, { "availability": "abundant" } } ] } } # 定義された条件に基づいてアイテムを挿入し、レスポンスで返されるアイテムを設定する。その他のサポートされている値は"OLD"と"NULL"です res = table.insert_items({ 'item': item, 'return': 'NEW' }) <br> ### 条件関数を使用したアイテム挿入 CatalystカスタムJSON形式で定義した特定の条件を使用して、NoSQLテーブルの既存アイテムに属性を挿入できます。このタイプでは、テーブルの既存データが取得され、指定された条件に対して評価されます。評価がtrueの場合にのみアイテムが挿入されます。既存データがない場合、条件は無視されアイテムが挿入されます。 Catalystは条件を評価するための複数の演算子をサポートしています。サポートされる演算子は以下のように表されます。 <table class="content-table nosql-components-table"> <thead> <tr> <th class="w10p">Operators</th> <th class="w10p">Notation</th> </tr> </thead> <tbody> <tr> <td>CONTAINS</td> <td>contains</td> </tr> <tr> <td>NOT_CONTAINS</td> <td>not_contains</td> </tr> <tr> <td>BEGINS_WITH</td> <td>begins_with</td> </tr> <tr> <td>ENDS_WITH</td> <td>ends_with</td> </tr> <tr> <td>IN</td> <td>in</td> </tr> <tr> <td>NOT_IN</td> <td>not_in</td> </tr> <tr> <td>BETWEEN</td> <td>between</td> </tr> <tr> <td>NOT_BETWEEN</td> <td>not_between</td> </tr> <tr> <td>EQUALS</td> <td>equals</td> </tr> <tr> <td>NOT_EQUALS</td> <td>not_equals</td> </tr> <tr> <td>GREATER_THAN</td> <td>greater_than</td> </tr> <tr> <td>LESS_THAN</td> <td>less_than</td> </tr> <tr> <td>GREATER_THAN_OR_EQUALS</td> <td>greater_equal</td> </tr> <tr> <td>LESSER_THAN_OR_EQUALS</td> <td>less_equal</td> </tr> <tr> <td>AND</td> <td>AND</td> </tr> <tr> <td>OR</td> <td>OR</td> </tr> </tbody> </table> <br> 以下の例では、既存データのネストされた属性fruitColourが値「Yellow」を含むという条件を定義しています。この属性は属性fruitPropertiesの一部です。条件が満たされた場合、属性fruitTypeとavailabilityがアイテムに追加されます。アイテムはinsert_items()メソッドを使用して挿入されます。 # 条件関数を使用してNoSQLアイテムを挿入する condition_function = { "function": { "function_name": "attribute_type", "args": [ { "attribute_path": ["fruitProperties", "[0]"] }, { "fruitColour": "Yellow" } ] } } item = { "Location": { "S": "Indonesia" }, "fruitName": { "S": "Banana" }, "fruitProperties": { "L": [ { "fruitType": "Berries" }, { "availability": "abundant" } } ] } } # 定義された条件に基づいてアイテムを挿入し、レスポンスの戻り値を設定する。その他のサポートされている値は"OLD"と"NULL"です res = table.insert_items({ 'item': item, 'condition': condition_function, 'return': 'NEW' }) <br> ### 条件演算子を使用したアイテム挿入 Catalystでは、CatalystカスタムJSON形式で演算子で定義された条件に基づいてアイテムを挿入することもできます。テーブルの既存データが取得され、指定された条件に対して評価されます。評価がtrueの場合にのみアイテムが挿入されます。既存データがない場合、条件は無視されアイテムが挿入されます。 Catalystは条件を評価するための複数の演算子をサポートしています。これらは[前のセクション](#insert-items-with-conditional-functions)に記載されています。 以下の例では、between演算子で定義された条件に基づいてアイテムを挿入しています。条件では、既存データの属性countが0から10の間の値を持つ場合にのみ、属性backupIDとcountがそれらのアイテムに挿入されることを示しています。アイテムはinsert_items()メソッドで挿入されます。 # 条件演算子を使用してNoSQLアイテムを挿入する condition_function = { "attribute": ["count"], "operator": "between", "value": { "L": [ { "N": "0" }, { "N": "10" } ] } } item = { "countryCode": { "N": 054 }, "backupID": { "N": 2379992 }, "count": { "N": "3" } } # 定義された条件に基づいてアイテムを挿入し、レスポンスの戻り値を設定する。その他のサポートされている値は"OLD"と"NULL"です res = table.insert_items({ 'item': item, 'condition': condition_function, 'return': 'NEW' }) -------------------------------------------------------------------------------- title: "アイテムの更新" description: "Catalyst NoSQLは、非リレーショナル・非SQLのデータストレージ手段を提供する、完全マネージドで強力なデータベースです。このページでは、NoSQLテーブルのアイテムを更新するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.352Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/nosql/update-items/" service: "Cloud Scale" -------------------------------------------------------------------------------- # NoSQLテーブルのアイテム更新 Catalystでは、アイテムを構築した後、特定のNoSQLテーブルのアイテムを更新できます。アイテムはプライマリキーを使用して識別することで更新できます。たとえば、パーティションキーのみ、またはパーティションキーとソートキーの組み合わせを使用してアイテムを識別できます。 次に、適切なHTTPリクエストメソッドで更新操作タイプを定義し、アイテムで更新する属性と値を提供します。 注意： Catalystでは、1回のSDK操作でNoSQLテーブルの最大25アイテムを一括更新できます。 以下の例では、パーティションキーfruitNameとソートキーlocationでアイテムを取得しています。このアイテムの更新対象の属性はcolorとtasteです。すべての属性の値が提供されています。 また、オプションで更新の条件を定義することもできます。条件が満たされた場合にのみ更新が実行されます。 # プライマリキーでNoSQLアイテムを識別して更新する res = table.update_items({ "keys": { "fruitName": { "S": "Banana" }, "location": { "S": "Indonesia" } },# アイテムで更新する属性を定義する "update_attributes": [ { "operation_type": "PUT", "color": { "S": "Yellow" }, "taste": { "S": "Sweet" }, "attribute_path": "fruitProperties" } ],# 条件を定義する。この条件が満たされた場合のみアイテムが更新される。（オプション） "condition" : { "function": { "function_name": "attribute_exists", "args": [ { "attribute_path": "fruitProperties" } ] } } }) print(res) -------------------------------------------------------------------------------- title: "アイテムの取得" description: "Catalyst NoSQLは、非リレーショナル・非SQLのデータストレージ手段を提供する、完全マネージドで強力なデータベースです。このページでは、NoSQLテーブルからアイテムを取得するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.352Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/nosql/fetch-items/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Basic Components (/ja/cloud-scale/help/nosql/components/#basic-components) - Working with Data (/ja/cloud-scale/help/nosql/working-with-data/introduction/) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/fetch-item/#FetchItem) -------------------------------------------------------------------------------- # NoSQLテーブルからのアイテム取得 Catalystでは、NoSQLテーブルからプライマリキーでアイテムを識別して取得できます。たとえば、パーティションキーのみ、またはパーティションキーとソートキーの組み合わせを使用してアイテムを取得できます。また、必要な属性を指定して、取得する属性をオプションでフィルタリングすることもできます。 注意： Catalystでは、1回のSDK読み取り操作でNoSQLテーブルから最大100アイテムを取得できます。 以下の例では、fetch_item()を使用して、パーティションキーfruitとソートキーlocationで識別されるアイテムを取得しています。required_objectsを使用して、propertiesやtasteなどの特定の属性がフィルタリングされて取得されます。 # パーティションキーとソートキーで識別されるNoSQLアイテムのプロパティを取得する res = table.fetch_item({ "keys": [ { "fruit": { "S": "apple" }, "location: { "S": "USA" } } ], # 取得する属性を指定する 'required_objects': ["properties", "taste"] }) print(res) -------------------------------------------------------------------------------- title: "テーブルのクエリ" description: "Catalyst NoSQLは、非リレーショナル・非SQLのデータストレージ手段を提供する、完全マネージドで強力なデータベースです。このページでは、NoSQLテーブルをクエリするSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.352Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/nosql/query-table/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Table Keys (/ja/cloud-scale/help/nosql/components/#table-keys) - Query Table (/ja/sdk/nodejs/v2/cloud-scale/nosql/query-table/) -------------------------------------------------------------------------------- # NoSQLテーブルのクエリ Catalystでは、テーブルのプライマリキーを使用してアイテムを識別し、NoSQLテーブルをクエリしてデータを取得できます。たとえば、パーティションキーのみ、またはパーティションキーとソートキーの組み合わせを使用してアイテムを取得できます。 注意： Catalystでは、1回のSDK操作でページネーションを使用してNoSQLテーブルから最大100アイテムを一括取得できます。SDKレスポンスで受け取ったstart_keyトークンを使用して、ページネーションのロジックを構築する必要があります。 属性、その必要な値、使用するサポートされる演算子を指定して、アイテムを識別するキー条件を定義できます。グループ演算子で追加条件を指定することもできます。 サポートされる演算子は以下のように表されます。 <table class="content-table nosql-components-table"> <thead> <tr> <th class="w10p">Operators</th> <th class="w10p">Notation</th> </tr> </thead> <tbody> <tr> <td>CONTAINS</td> <td>contains</td> </tr> <tr> <td>NOT_CONTAINS</td> <td>not_contains</td> </tr> <tr> <td>BEGINS_WITH</td> <td>begins_with</td> </tr> <tr> <td>ENDS_WITH</td> <td>ends_with</td> </tr> <tr> <td>IN</td> <td>in</td> </tr> <tr> <td>NOT_IN</td> <td>not_in</td> </tr> <tr> <td>BETWEEN</td> <td>between</td> </tr> <tr> <td>NOT_BETWEEN</td> <td>not_between</td> </tr> <tr> <td>EQUALS</td> <td>equals</td> </tr> <tr> <td>NOT_EQUALS</td> <td>not_equals</td> </tr> <tr> <td>GREATER_THAN</td> <td>greater_than</td> </tr> <tr> <td>LESS_THAN</td> <td>less_than</td> </tr> <tr> <td>GREATER_THAN_OR_EQUALS</td> <td>greater_equal</td> </tr> <tr> <td>LESSER_THAN_OR_EQUALS</td> <td>less_equal</td> </tr> <tr> <td>AND</td> <td>AND</td> </tr> <tr> <td>OR</td> <td>OR</td> </tr> </tbody> </table> <br> 以下の例では、パーティションキーfruitTypeを使用してアイテムを識別し、条件値を「citrus」として指定してqueryTable()メソッドでクエリを実行しています。また、属性locationが「USA」に一致する追加条件も指定しています。 Catalyst NoSQLでは、consistent_readを使用して読み取り操作をマスターまたはスレーブクラスターのどちらで実行するかを示す、返される行数の制限、昇順でのソート順の指定など、クエリの他の要素も定義できます。 注意： マスター・スレーブレプリケーションでは、マスターにはデータベースのすべてのデータが含まれ、スレーブにはマスターからのコピーが含まれます。スレーブから読み取り操作を実行すると、更新されたデータの反映に若干の遅延があるというトレードオフで、全体的なコストを削減できます。 # パーティションキーfruitTypeの値が"citrus"であるアイテムを取得するためにNoSQLテーブルをクエリする res = table.query_table( { # consistent_readをtrueに設定してマスターからクエリする。falseの場合、スレーブからクエリされる。 'consistent_read': 'true',# forwardScanをtrueに設定して結果を昇順でソートする。それ以外の場合は降順でソートされる。 'forwardScan': 'true',# 値を指定して返される行数を制限する 'limit': 10,# アイテムを識別するためのキー条件を定義する 'key_condition': { 'attribute': 'fruitType', 'operator': 'equals', 'value': { 'S': 'citrus' } }, # グループ演算子を使用してテーブルアイテムをクエリするための追加条件を指定する 'other_condition': { 'group_operator': 'and', 'group': [ { 'attribute': 'location', 'operator': 'equals', 'value': { 'S': 'USA' } } ] } }) print(res) -------------------------------------------------------------------------------- title: "インデックスのクエリ" description: "Catalyst NoSQLは、非リレーショナル・非SQLのデータストレージ手段を提供する、完全マネージドで強力なデータベースです。このページでは、NoSQLインデックスをクエリするSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.352Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/nosql/query-index/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Table Keys (/ja/cloud-scale/help/nosql/components/#table-keys) - Query Index (/ja/sdk/nodejs/v2/cloud-scale/nosql/query-index/) -------------------------------------------------------------------------------- # インデックスのクエリ Catalystでは、インデックスのプライマリキーを使用してアイテムを識別し、NoSQLインデックスをクエリしてデータを取得できます。インデックスを使用すると、メインテーブルのプライマリキーを使用せずに、テーブルデータに対して代替クエリを実行できます。Catalystコンソールからインデックスを設定できます。インデックスのパーティションキーのみ、またはパーティションキーとソートキーの組み合わせを使用してアイテムを取得できます。 注意： Catalystでは、1回のSDK操作でページネーションを使用してNoSQLテーブルから最大100アイテムを一括取得できます。SDKレスポンスで受け取ったstart_keyトークンを使用して、ページネーションのロジックを構築する必要があります。 属性、その必要な値、使用するサポートされる演算子を指定して、アイテムを識別するキー条件を定義できます。グループ演算子で追加条件を指定することもできます。 サポートされる演算子は以下のように表されます。 <table class="content-table nosql-components-table"> <thead> <tr> <th class="w10p">Operators</th> <th class="w10p">Notation</th> </tr> </thead> <tbody> <tr> <td>CONTAINS</td> <td>contains</td> </tr> <tr> <td>NOT_CONTAINS</td> <td>not_contains</td> </tr> <tr> <td>BEGINS_WITH</td> <td>begins_with</td> </tr> <tr> <td>ENDS_WITH</td> <td>ends_with</td> </tr> <tr> <td>IN</td> <td>in</td> </tr> <tr> <td>NOT_IN</td> <td>not_in</td> </tr> <tr> <td>BETWEEN</td> <td>between</td> </tr> <tr> <td>NOT_BETWEEN</td> <td>not_between</td> </tr> <tr> <td>EQUALS</td> <td>equals</td> </tr> <tr> <td>NOT_EQUALS</td> <td>not_equals</td> </tr> <tr> <td>GREATER_THAN</td> <td>greater_than</td> </tr> <tr> <td>LESS_THAN</td> <td>less_than</td> </tr> <tr> <td>GREATER_THAN_OR_EQUALS</td> <td>greater_equal</td> </tr> <tr> <td>LESSER_THAN_OR_EQUALS</td> <td>less_equal</td> </tr> <tr> <td>AND</td> <td>AND</td> </tr> <tr> <td>OR</td> <td>OR</td> </tr> </tbody> </table> <br> 以下の例では、一意のインデックスIDで参照されるインデックスを使用してクエリを実行しています。クエリはインデックスのパーティションキーfruitColorを使用してアイテムを識別し、条件値を「yellow」として指定しています。また、属性fruitTypeが「citrus」に一致する追加条件も指定しています。クエリはquery_index()メソッドを使用して実行されます。 Catalyst NoSQLでは、consistent_readを使用して読み取り操作をマスターまたはスレーブクラスターのどちらで実行するかを示す、返される行数の制限、昇順でのソート順の指定など、クエリの他の要素も定義できます。 注意： マスター・スレーブレプリケーションでは、マスターにはデータベースのすべてのデータが含まれ、スレーブにはマスターからのコピーが含まれます。スレーブから読み取り操作を実行すると、更新されたデータの反映に若干の遅延があるというトレードオフで、全体的なコストを削減できます。 # パーティションキーfruitColourの値が"yellow"であるアイテムを取得するためにNoSQLテーブルインデックスをクエリする# インデックスの一意のIDを渡す cres = table.query_index('6759000000740017', { # consistent_readをtrueに設定してマスターからクエリする。falseの場合、スレーブからクエリされる。 'consistent_read': 'true',# forward_scanをtrueに設定して結果を昇順でソートする。それ以外の場合は降順でソートされる。 'forwardScan': 'true',# 値を指定して返される行数を制限する 'limit': 10,# アイテムをクエリするためのキー条件を定義する 'key_condition': { 'attribute': 'fruitColor', 'operator': 'equals', 'value': { 'S': 'yellow' } }, # グループ演算子を使用してデータをクエリするための追加条件を定義する 'other_condition': { 'group_operator': 'AND', 'group': [ { 'attribute': 'fruitType', 'operator': 'equals', 'value': { 'S': 'citrus' } } ] } }) print(res) -------------------------------------------------------------------------------- title: "アイテムの削除" description: "Catalyst NoSQLは、非リレーショナル・非SQLのデータストレージ手段を提供する、完全マネージドで強力なデータベースです。このページでは、NoSQLテーブルからアイテムを削除するSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.352Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/nosql/delete-items/" service: "Cloud Scale" related: - NoSQL (/ja/cloud-scale/help/nosql/introduction) - Working with Data (/ja/cloud-scale/help/nosql/working-with-data/introduction/) - Basic Components (/ja/cloud-scale/help/nosql/components/#basic-components) - NoSQL API (/ja/api/code-reference/cloud-scale/nosql/delete-item/#DeleteItem) -------------------------------------------------------------------------------- # NoSQLテーブルからのアイテム削除 テーブルのプライマリキーを使用してアイテムを識別することで、CatalystのNoSQLテーブルからアイテムを削除できます。たとえば、パーティションキーのみ、またはテーブルのパーティションキーとソートキーの組み合わせを使用してアイテムを識別します。 注意： Catalystでは、1回のSDK操作でNoSQLテーブルから最大25アイテムを一括削除できます。 削除操作は、以下の例に示すようにdelete_items()メソッドを使用して実行されます。パーティションキーfruitが「apple」に一致し、ソートキーlocationが「USA」に一致するアイテムが削除されます。削除の追加条件を指定することもできます。アイテムが条件に一致する場合にのみ削除されます。 # パーティションキーとソートキーで識別してテーブルからNoSQLアイテムを削除する res = table.delete_items( { "keys": { "fruit": { "S": "apple" }, "location": { "S": "USA" } } }), # 削除の条件を指定する（オプション） "condition": { "function": { "function_name": "attribute_exists", "args": [ { "attribute_path": ["properties"] } ] } } }) print(res) ##### Stratus -------------------------------------------------------------------------------- title: "概要" description: "このページでは、コードを通じてStratus操作を実行するために必要なすべてのPython SDKメソッドを一覧で示します。" last_updated: "2026-06-10T06:04:54.353Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/overview/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/overview/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/overview/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Stratus ## 概要 Cloud Scale Stratusは、Catalystの堅牢で強力なストレージソリューションです。バケットと呼ばれるコンテナに、あらゆる形式のデータをオブジェクトとして保存できます。各バケットおよびバケット内の個々のオブジェクトには、安全なオブジェクトURLとバケットURLがあります。オブジェクトに対してアップロードおよびダウンロード操作を実行でき、各オブジェクトにカスタム権限を設定することもできます。 以下の表には、コードを通じてStratus操作を実行するために使用できるすべてのCatalyst SDKの一覧が含まれています。 <table class="content-table"> <thead> <tr> <th class="w30p">カテゴリ</th> <th class="w70p">SDKメソッド</th> </tr> </thead> <tbody> <tr> <td>一般的なStratus操作</td> <td> <ul> <li>Stratusインスタンスの作成</li> <li>バケットの可用性確認</li> <li>すべてのバケットの一覧取得</li> </ul> </td> </tr> <tr> <td>バケット操作</td> <td> <ul> <li>バケットインスタンスの作成</li> <li>バケット詳細の取得</li> <li>バケットCORSの取得</li> <li>バケット内のオブジェクト一覧取得 <ul> <li>ページネーションによるすべてのオブジェクトの一覧取得</li> <li>イテレーションによるオブジェクトの一覧取得</li> </ul> </li> <li>オブジェクトの可用性確認</li> <li>オブジェクトのダウンロード <ul> <li>オブジェクトのダウンロード</li> <li>オブジェクトの一部をダウンロード</li> <li>Transfer Managerを使用したオブジェクトのダウンロード</li> <li>オブジェクトダウンロード用の署名付きURLの生成</li> </ul> </li> <li>オブジェクトのアップロード <ul> <li>ストリームとしてオブジェクトをアップロード</li> <li>文字列としてオブジェクトをアップロード</li> <li>オプション付きでオブジェクトをアップロード</li> <li>マルチパートを使用したオブジェクトのアップロード</li> <li>Transfer Managerを使用したオブジェクトのアップロード</li> <li>オブジェクトアップロード用の署名付きURLの生成</li> </ul> </li> <li>Zipオブジェクトの展開 <ul> <li>Zip展開ステータスの取得 </ul> </li> <li>オブジェクトのコピー</li> <li>オブジェクトの名前変更と移動操作</li> <li>オブジェクトの削除 <ul> <li>単一オブジェクトの削除</li> <li>指定時間後にオブジェクトの特定バージョンを削除</li> <li>複数オブジェクトの削除</li> <li>バケットのトランケート</li> <li>バケット内のパスの削除</li> </ul> </li> </td> </tr> <tr> <td>オブジェクト操作</td> <td> <ul> <li>オブジェクトインスタンスの作成</li> <li>オブジェクトバージョンの一覧取得 <ul> <li>ページネーションによるオブジェクトのすべてのバージョンの一覧取得</li> <li>イテレーションによるオブジェクトのすべてのバージョンの一覧取得</li> </ul> </li> <li>オブジェクト詳細の取得 <ul> <li>すべてのオブジェクトの詳細取得</li> <li>オブジェクトの特定バージョンの詳細取得</li> </ul> </li> <li>オブジェクトメタデータの設定</li> </ul> </td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "Stratusインスタンスの作成" description: "このページでは、Stratusインスタンスを作成するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.353Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/create-stratus-instance/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/create-stratus-instance/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/create-stratus-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/initialize-stratus-instance/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/create-bucket-instance/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/initialize-stratus/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Stratusインスタンスの作成 以下に示すように、stratusコンポーネントの参照を取得できます。これはサーバーサイドの呼び出しを実行しません。Stratusを操作するさまざまなコードスニペットで、このコンポーネントインスタンスを参照します。以下のコードスニペットで使用されているappの参照は、Catalystインスタンスです。 stratus = app.stratus() -------------------------------------------------------------------------------- title: "バケットの可用性確認" description: "このページでは、プロジェクト内にバケットが存在するかどうかを確認するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.353Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/check-bucket/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/check-bucket/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/check-bucket/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/check-bucket/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # バケットの可用性確認 head_bucket() SDKメソッドを使用すると、Stratus内のバケットの存在を確認し、さらにユーザーがバケット内のオブジェクトにアクセスするための関連権限を持っているかどうかを確認できます。以下のコードスニペットで使用されているstratusの参照は、コンポーネントインスタンスです。 このSDKを使用した場合のレスポンス： * バケットが存在し、ユーザーがバケットにアクセスするための関連権限を持っている場合、レスポンスとして「**true**」が返されます。 * バケットが存在しない場合、またはユーザーがバケットにアクセスする権限を持っていない場合、レスポンスとして「**false**」が返されます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>bucket_name</td> <td>String</td> <td>必須パラメータです。バケットの一意の名前を保持します。</td> </tr> <tr> <td>throw_err</td> <td>Boolean</td> <td>任意パラメータです。このパラメータを「true」に設定すると、プロジェクト内にバケットが見つからない場合にエラーをスローします。デフォルト値は「false」です。</td> </tr> </tbody> </table> bucket_res = stratus.head_bucket('bucket_name', throw_err=False) print(bucket_res) #### 発生する可能性のあるエラー 注意： throw_errパラメータを使用してSDKを使用し、バケットが存在しない場合、または十分な権限がない場合、以下に示すエラーのいずれかが発生する可能性があります。 <table class="content-table"> <thead> <tr> <th class="w30p">エラーコード</th> <th class="w70p">意味</th> </tr> </thead> <tbody> <tr> <td>404</td> <td>Not Found。Stratus内にバケットが見つかりません。</td> </tr> <tr> <td>401</td> <td>Unauthorized/Access Denied - ユーザーは特定の操作を実行する権限がありません。</td> </tr> <tr> <td>403</td> <td>Permission Denied - ユーザーは特定のバケットにアクセスする権限がありません。</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "すべてのバケットの一覧取得" description: "このページでは、プロジェクト内に作成されたバケットを一覧取得するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.353Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/list-buckets/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/list-buckets/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/list-buckets/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # すべてのバケットの一覧取得 以下のSDKメソッドは、プロジェクト内に存在するすべてのバケットを返します。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 以下のコードスニペットで使用されているstratusの参照は、コンポーネントインスタンスです。 buckets = stratus.list_buckets() # すべてのバケットとその詳細を返す print(buckets) #### レスポンス例 [ { "bucket_name": "zcstratus122", "project_details": { "project_name": "Learn", "id": "6759000000014001", "project_type": "Live" }, "created_by": { "zuid": "74660608", "is_confirmed": "False", "email_id": "emmy@zylker.com", "first_name": "Amelia Burrows", "last_name": "C", "user_type": "Admin", "user_id": "6759000000009004" }, "created_time": "Mar 26, 2024 12:44 PM", "modified_by": { "zuid": "74660608", "is_confirmed": "False", "email_id": "emmy@zylker.com", "first_name": "Amelia Burrows", "last_name": "C", "user_type": "Admin", "user_id": "6759000000009004" }, "modified_time": "Mar 30, 2024 11:38 AM", "bucket_meta": { "versioning": "False", "caching": { "status": "Enabled", "delivery_point_id": "01ht6zj7k536c29ymsgfeky1mg" }, "encryption": "False", "audit_consent": "False" }, "bucket_url": "https://zcstratus122-development.zohostratus.com" }, { "bucket_name": "zcstratus12345", "project_details": { "project_name": "Learn", "id": "6759000000014001", "project_type": "Live" }, "created_by": { "zuid": "74660608", "is_confirmed": "False", "email_id": "emmy@zylker.com", "first_name": "Amelia Burrows", "last_name": "C", "user_type": "Admin", "user_id": "6759000000009004" }, "created_time": "Mar 13, 2024 05:51 PM", "modified_by": { "zuid": "74660608", "is_confirmed": "False", "email_id": "emmy@zylker.com", "first_name": "Amelia Burrows", "last_name": "C", "user_type": "Admin", "user_id": "6759000000009004" }, "modified_time": "Apr 18, 2024 12:44 PM", "bucket_meta": { "versioning": "True", "caching": { "status": "Enabled", "delivery_point_id": "01hrxy25tv1vex73qhm85g88bf" }, "encryption": "False", "audit_consent": "False" }, "bucket_url": "https://zcstratus12345-development.zohostratus.com" } ] -------------------------------------------------------------------------------- title: "バケットインスタンスの作成" description: "このページでは、バケットインスタンスを作成するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.354Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/create-bucket-instance/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - バケットの作成ヘルプドキュメント (/ja/cloud-scale/help/stratus/buckets/create-bucket/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/create-bucket-instance/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/create-bucket-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # バケットインスタンスの作成 バケットレベルの操作を実行するには、バケットインスタンスを作成する必要があります。Stratusのバケットを操作するさまざまなコードスニペットで、このコンポーネントインスタンスを参照します。以下のコードスニペットで使用されているstratusの参照は、コンポーネントインスタンスです。 bucket = stratus.bucket('bucket_name') -------------------------------------------------------------------------------- title: "バケット詳細の取得" description: "このページでは、バケットの詳細を取得するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.354Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/get-bucket-details/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - バケットの作成ヘルプドキュメント (/ja/cloud-scale/help/stratus/buckets/create-bucket/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/create-bucket-instance/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/create-bucket-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # バケット詳細の取得 以下のSDKメソッドを使用すると、特定のバケットの利用可能なすべての詳細を取得できます。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 bucket_details = bucket.get_details() print(bucket_details) #### レスポンス例 { "bucket_name": "zcstratus122", "project_details": { "project_name": "Learn", "id": "6759000000014001", "project_type": "Live" }, "created_by": { "zuid": "74660608", "is_confirmed": "False", "email_id": "emmy@zylker.com", "first_name": "Amelia Burrows", "last_name": "C", "user_type": "Admin", "user_id": "6759000000009004" }, "created_time": "Mar 26, 2024 12:44 PM", "modified_by": { "zuid": "74660608", "is_confirmed": "False", "email_id": "emmy@zylker.com", "first_name": "Amelia Burrows", "last_name": "C", "user_type": "Admin", "user_id": "6759000000009004" }, "modified_time": "Mar 30, 2024 11:38 AM", "bucket_meta": { "versioning": "False", "caching": { "status": "Enabled", "delivery_point_id": "01ht6zj7k536c29ymsgfeky1mg" }, "encryption": "False", "audit_consent": "False" }, "bucket_url": "https://zcstratus122-development.lzstratus.com", "caching_url": "https://zcstratus122-development.nimbuslocaledge.com", "objects_count": "74", "size_in_bytes": "925906411" } -------------------------------------------------------------------------------- title: "バケットCORSの取得" description: "このページでは、バケットの現在のCORS設定を取得するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.354Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/get-bucket-cors/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - StratusバケットCORSヘルプドキュメント (/ja/cloud-scale/help/stratus/stratus-config/bucket-cors/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/get-bucket-cors/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/get-bucket-cors/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # バケットCORSの取得 get_cors() SDKメソッドは、Stratus内の特定のバケットの現在のCORS設定を返します。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 バケットのCORSは、プロファイルと権限セクションを使用して、プロジェクト内のStratusコンポーネントに対するWrite権限を持つ、または付与されたすべてのユーザーが編集できます。 注意： バケットCORSの詳細については、こちらのヘルプセクションをご覧ください。 res = bucket.get_cors() print(res) -------------------------------------------------------------------------------- title: "バケット内のオブジェクト一覧取得" description: "このページでは、バケットに保存されているすべてのオブジェクトを一覧取得するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.354Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/list-objects/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/list-objects/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/list-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # バケット内のオブジェクト一覧取得 ### ページネーションによるすべてのオブジェクトの一覧取得 このSDKメソッドを使用すると、特定のバケット内に存在するすべてのオブジェクトをページネーションで取得できます。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 各呼び出しでは限られた数のオブジェクトが返され、継続トークンが返された場合にのみ次の呼び出しが開始されます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>max_keys</td> <td>String</td> <td>必須パラメータです。ページネーションで一覧取得できるオブジェクトの最大数を保持します。</td> </tr> <tr> <td>continuation_token</td> <td>String</td> <td>必須パラメータです。次のオブジェクトセットを取得するためのトークンを保持します。</td> </tr> <tr> <td>prefix</td> <td>String</td> <td>任意パラメータです。プレフィックス値に一致するオブジェクトを一覧取得します。</td> </tr> <tr> <td>order_by</td> <td>String</td> <td>任意パラメータです。オブジェクトを昇順または降順で一覧取得します。デフォルト値: asc</td> </tr> <tr> <td>folder_listing</td> <td>String</td> <td>任意パラメータです。バケット内のルートレベルのオブジェクトのみを一覧取得するか、バケット内のすべてのパスに存在するすべてのオブジェクトを一覧取得するかを選択します。デフォルト値: false<br />例えば、値をtrueに設定すると、ルートレベルのオブジェクトのみが一覧表示されます。値をfalseに設定すると、バケット内のすべてのパスに存在するすべてのオブジェクトが一覧表示されます。 </td> </tr> </tbody> </table> 以下のSDKメソッドでは、max_keysを使用してページネーションの最大値を設定します。prefixを使用すると、prefix:に一致するオブジェクトのみを一覧取得できます。 取得するレスポンスには、バケットの以下のプロパティが含まれ、moreOptionsに格納されます： * key count: 返されるオブジェクトの数の値を保持します * max_key: 返されるオブジェクトの最大数 * Truncated: バケットがトランケートされているかどうかのステータスを保持します * contents: オブジェクト詳細のリスト * next_token: レスポンスがトランケートされた場合、このキーの値を次のオブジェクトセットを取得するために同じメソッドにnext_tokenとして渡す必要があります。 各イテレーションで、max_keysの数のオブジェクトを一覧取得し、next_tokenが作成されたかどうかを確認します。next_tokenを使用して、すべてのオブジェクトが一覧取得されるまでイテレーションを続けます。 # ページネーションを使用してバケットからオブジェクトを一覧取得する再帰関数を定義する def list_my_paged_objects(max_keys=None, prefix=None, next_token=None): # 指定されたオプションでバケットからページ分割されたオブジェクトリストを取得する data = bucket.list_paged_objects( max_keys, # この呼び出しで取得するオブジェクトの最大数 prefix, # このプレフィックスで始まるオブジェクトをフィルタリングする next_token, # 次のページの結果を取得するための継続トークン folder_listing=True, # フォルダ構造でオブジェクトを一覧表示する order_by='desc' # オブジェクトを降順でソートする（最新のものが先頭） ) # 取得したオブジェクトのリストを表示する print(data['contents']) # さらにオブジェクトが利用可能かどうかを確認する（ページネーションがまだ完了していない場合） if data['truncated']: # 再帰的に関数を呼び出して次のページのオブジェクトを取得する list_my_paged_objects(max_keys, prefix, data['next_continuation_token']) #ページサイズ2でオブジェクトの一覧取得を開始する list_my_paged_objects(2, 'sam') #### レスポンス例 { "prefix": "sam", "key_count": "5", "max_keys": "5", "truncated": "True", "next_continuation_token": "47VrqTzR9ukMF9gr8YcziVVzdRP5GCjq1NfM5fMBpMfvw5qcXFRSueuqCTRUCzNd9dHfquXHi2afDanLH6MbyJo6", "contents": [ { "key_type": "file", "key": "sam1s2ww.mp4", "size": "427160684", "content_type": "video/mp4", "etag": "78c2b173b56cd944e9c79abd601f6073", "last_modified": "May 21, 2024 01:00 PM" }, { "key_type": "file", "key": "samdm.txt", "size": "23", "content_type": "text/plain; charset=utf-8", "etag": "c0122754f465e42eb97b5af174663c29", "last_modified": "May 14, 2024 01:30 PM" }, { "key_type": "file", "key": "samplvbse1.json", "size": "8", "content_type": "application/json", "etag": "499e7dbaee453352a9c17407a676dbda", "last_modified": "May 13, 2024 10:05 AM" }, { "key_type": "file", "key": "samplse1.json", "size": "8", "content_type": "application/json", "etag": "499e7dbaee453352a9c17407a676dbda", "last_modified": "May 13, 2024 09:20 AM" }, { "key_type": "file", "key": "sampjkhdldbed.mp4", "size": "0", "content_type": "video/mp4", "etag": "d41d8cd98f00b204e9800998ecf8427e", "last_modified": "May 12, 2024 10:54 PM" } ] } ### イテレーションによるオブジェクトの一覧取得 このSDKメソッドを使用すると、イテレーション技術を使用して、単一のAPI呼び出しでバケット内に存在するすべてのオブジェクトを取得できます。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 # 指定されたオプションでイテラブルページネーションを使用してバケットからオブジェクトを一覧取得する objects = bucket.list_iterable_objects( max_keys=5, # バッチごとに取得するオブジェクトの最大数（デフォルトは1000） prefix='sam', # このプレフィックスで始まるオブジェクトをフィルタリングする folder_listing=True, # フォルダ構造でオブジェクトを一覧表示する（デフォルトはFalse） order_by='desc' # オブジェクトを降順でソートする（デフォルトは'asc'） ) #各オブジェクトキーをイテレーションして表示する for key in objects: print(key) #### レスポンス例 { "key_type": "file", "key": "ssdgs.mp4", "size": "3145728", "content_type": "video/mp4", "etag": "9685b8d5b8b719274bac854b897d95ec", "last_modified": "May 21, 2024 03:49 PM" } { "key_type": "file", "key": "Sasss.mp4", "size": "2674", "content_type": "video/mp4", "etag": "24c1122087e9be930ff1e957e83f5224", "last_modified": "May 21, 2024 02:55 PM" } { "key_type": "file", "key": "Samfplessss.mp4", "size": "2674", "content_type": "video/mp4", "etag": "24c1122087e9be930ff1e957e83f5224", "last_modified": "May 21, 2024 02:52 PM" } { "key_type": "file", "key": "demo.mp4", "size": "3400", "content_type": "video/mp4", "etag": "24e957e83f5224c1122087e9be930ff1", "last_modified": "May 21, 2024 02:52 PM" } { "key_type": "file", "key": "performance.mp4", "size": "1454", "content_type": "video/mp4", "etag": "087e9be930ff124c1122e957e83f5224", "last_modified": "May 21, 2024 02:52 PM" } -------------------------------------------------------------------------------- title: "オブジェクトのダウンロード" description: "このページでは、バケットからオブジェクトをダウンロードするためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.354Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/download-object/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/download-object/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/download-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/download-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/download-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/download-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/download-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトのダウンロード ### オブジェクトのダウンロード このセクションのSDKを使用すると、特定のオブジェクトのダウンロード、複数のオブジェクト、またはオブジェクトのバージョンをダウンロードできます。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 ダウンロード操作の最初のステップは、バケットから必要なオブジェクトを取得するGET操作です。 オブジェクトをダウンロードするには、リクエスターがREADアクセス権限を持っている必要があります。ただし、バケットの所有者は、必要なレスポンスヘッダーを使用せずにオブジェクトをダウンロードできるように、ユーザーにREADアクセス権限を付与するオプションがあります。 バケットでバージョニングが有効な場合、オブジェクトの特定のバージョンをダウンロードするにはversionIdを渡す必要があります。versionIdが渡されない場合、デフォルトで最新バージョンのオブジェクトがダウンロードされます。 バケットの*バージョニング*が有効にされた後に無効にされた場合、デフォルトでは最初のプリンシパルオブジェクトがダウンロードされます。このオブジェクトの最新バージョンをダウンロードするには、versionIdパラメータに値「topVersion」を渡す必要があります。 res = bucket.get_object("sam/out/sample.txt") # オブジェクトをローカルマシンにダウンロードする file = open('file_path','wb') file.write(res) ### オブジェクトの一部をダウンロード 以下のSDKメソッドは、rangeパラメータとともに使用されます。rangeパラメータを使用すると、オブジェクトの特定のrangeのバイトをダウンロードできます。 options = { 'version_id': '01hx66f1383jm48w9sa4z20kve', # 指定されたバージョンIDのオブジェクトをダウンロードする 'range': '0-200' # オブジェクトの開始と終了の範囲 } res = bucket.get_object('"sam/out/sample.txt", options) # オブジェクトをローカルマシンにダウンロードする file = open('file_path','wb') file.write(res) ### Transfer Managerを使用したオブジェクトのダウンロード このセクションでは、**Transfer Manager**技術を使用してStratusからローカルシステムに大きなオブジェクトを正常にダウンロードするためのSDKメソッドについて説明します。Transfer Managerは、オブジェクトの開始バイトと終了バイトの範囲を使用して、大きなオブジェクトを複数のバイト範囲に分割する操作です。オブジェクトの各パーツはストリームとして返され、ローカルシステムにダウンロードされます。 #### Transfer Managerインスタンスの取得 Transfer Manager操作を実行するには、Transfer Managerオブジェクトインスタンスを取得する必要があります。Stratus内のバケットに保存されているオブジェクトに対するTransfer Manager操作を実行するさまざまなコードスニペットで、このコンポーネントインスタンスを参照します。 **使用するパラメータ** bucket: こちらのSDKメソッドを使用して事前に初期化したバケットインスタンスです。 **以下のパッケージがインポートされていることを確認してください** from zcatalyst_sdk.stratus.transfer_manager import TransferManager transfer_manager = TranferManager(bucket) #### イテラブルオブジェクトの取得 イテラブルオブジェクトのパーツを返します。ユーザーはイテレーターを使用してこれらのパーツをローカルマシンに書き込むことができます。 注意： イテラブルパーツを返すため、オブジェクト全体ではなく、単一のファイルに書き込んでください。個別のファイルに書き込む場合は、それらを1つに結合する必要があります。 情報： part_sizeはMb単位で指定してください。 res = transfer_manager.get_iterable_object("sam/out/sample.txt", 20) file = open('file_path','wb') # オブジェクトをローカルマシンに保存する for chunk in res: file.write(chunk) #### オブジェクトパーツダウンローダーの生成 ユーザーが大きなファイル（例：10 GBのファイル）をダウンロードする必要がある場合、get_object()メソッドの使用は実用的ではありません。代わりに、ユーザーはこのSDKメソッドを選択できます。generate_part_downloaders()メソッドをパラメータkey(str)とpart_size(Long)で呼び出すことにより、ユーザーはTransfer Manager関数を取得できます。これらの関数は昇順で返され、それぞれがオブジェクトの特定のパーツをダウンロードします。パーツは指定されたパーツサイズに基づいて決定されます。 res = transfer_manager.generate_part_downloaders("sam/out/sample.txt",20) file = open('file_path','wb') for part in res: file.write(part()) 情報： 部分ダウンロードを有効にするには、ファイルをAPIまたはSDK経由でアップロードする必要があります。part_sizeは5 MBより大きく100 MB未満である必要があります。 ### オブジェクトダウンロード用の署名付きURLの生成 署名付きURLは、認証済みユーザーが非認証ユーザーに共有できるセキュアなURLです。このURLは、非認証ユーザーにオブジェクトへのアクセスのための一時的な認可を提供します。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトのパスを含む完全な名前を保持します。</td> </tr> <tr> <td>url_action</td> <td>Request Method</td> <td>必須パラメータです。ダウンロード（GET）アクション用の署名付きURLを生成するためのパラメータです。 <ul> <li>**GET**: オブジェクトをダウンロードする場合</li> </ul> </td> </tr> <tr> <td>expiry</td> <td>String</td> <td>任意パラメータです。URLの有効期間（秒単位）です。 <ul> <li>デフォルト値: 3600秒</li> <li>最小値: 30秒</li> <li>最大値: 7日間</li> </ul> </td> </tr> <tr> <td>active_from</td> <td>String</td> <td>任意パラメータです。URLが有効になる時刻を保持します。最大値は7日間です。デフォルトでは、URLは生成されるとすぐに有効になります。</td> </tr> </tbody> </table> pre_signed_url_res = bucket.generate_presigned_url("sam/out/sample.txt",url_action='GET',expiry_in_sec='300', active_from='1023453725828', version_id='jdery748tfge78') print(pre_signed_url_res) **ダウンロード用署名付きURL生成のレスポンス例** { "signature": "https://zcstratus123-development.zohostratus.com/_signed/sam/out/sample.txt?organizationId=83963316&stsCredential=74660608-83963316&stsDate=1726492859577&stsExpiresAfter=300&stsSignedHeaders=host&stsSignature=_G8mnq-03vKgPlnJPmqBvzEnT3Hk-SnECuG-cgURyDs", "expiry_in_seconds": "300", "active_from": "1726492859577" } **署名付きURLを使用したオブジェクトダウンロードのスニペット例** import requests #ファイルをダウンロードするための署名付きURL url = "https://sadi-development.zohostratus.com/_signed/code.txt?organizationId=96862383&stsCredential=96858154-96862383&stsDate=1747899927592&stsExpiresAfter=300&stsSignedHeaders=host&stsSignature=-l10AlSsbZzkq6t8HHgDfNkEiiDWFaaU9M3-hPBz0M8" #ダウンロードしたファイルをローカルに保存するパス file_path = "file_path" # 実際のファイルパスに置き換える #GETリクエストを送信してファイルをダウンロードする response = requests.get(url, stream=True) #リクエストが成功したかどうかを確認する if response.status_code == 200: #バイナリ書き込みモードで保存先ファイルを開く with open(file_path, "wb") as f: #大きなファイルを処理するためにチャンク単位でデータを書き込む for chunk in response.iter_content(chunk_size=8192): if chunk: f.write(chunk) print("Download completed successfully.") else: print("Object download failed. Status code:", response.status_code) -------------------------------------------------------------------------------- title: "オブジェクトの可用性確認" description: "このページでは、バケット内にオブジェクトが存在するかどうかを確認するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.355Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/check-object-availability/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/check-object-availability/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/check-object-availability/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトの可用性確認 このSDKメソッドを使用すると、バケット内に特定のオブジェクトが存在するか、ユーザーがオブジェクトにアクセスするために必要な権限を持っているかを確認できます。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 バケットのバージョニングを有効にしている場合、特定のバージョンのオブジェクトが利用可能かどうかを確認するには、パラメータとしてversion_id を渡す必要があります。 このSDKメソッドを使用すると、以下のいずれかのレスポンスが返されます： - **true**: オブジェクトが利用可能で、指定されたバージョンが利用可能で、ユーザーがオブジェクトにアクセスするための関連権限を持っている場合。 - **false**: - オブジェクトまたはオブジェクトの特定バージョンがバケット内に存在しない場合。 - ユーザーがオブジェクトにアクセスするために必要な権限を持っていない場合。 - バケットが存在しない場合。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトの完全な名前を保持します。</td> </tr> <tr> <td>version_id</td> <td>String</td> <td>任意パラメータです。バージョニングが有効な場合、オブジェクトの一意のバージョンIDを保持します。</td> </tr> <tr> <td>throw_err</td> <td>Boolean</td> <td>任意パラメータです。このパラメータを「true」に設定すると、プロジェクト内にバケットが見つからない場合にエラーをスローします。デフォルト値は「false」です。</td> </tr> </tbody> </table> head_object_res = bucket.head_object( "sam/out/sample.txt", 'version_id', throw_err=False) print(head_object_res) #### 発生する可能性のあるエラー 注意： throw_errパラメータを使用してSDKを使用し、オブジェクトが存在しない場合、または十分な権限がない場合、以下に示すエラーのいずれかが発生する可能性があります。 <table class="content-table"> <thead> <tr> <th class="w30p">エラーコード</th> <th class="w70p">意味</th> </tr> </thead> <tbody> <tr> <td>404</td> <td>Not Found。Stratus内にオブジェクトが見つかりません。</td> </tr> <tr> <td>401</td> <td>Unauthorized/Access Denied - ユーザーは特定の操作を実行する権限がありません。</td> </tr> <tr> <td>403</td> <td>Permission Denied - ユーザーは特定のオブジェクトにアクセスする権限がありません。</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "オブジェクトのアップロード" description: "このページでは、バケットにオブジェクトをアップロードするためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.355Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/upload-object/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - オブジェクトのアップロードヘルプドキュメント (/ja/cloud-scale/help/stratus/objects/upload-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/upload-object/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/upload-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/upload-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/upload-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/upload-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/upload-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトのアップロード このセクションに記載されているSDKメソッドを使用すると、さまざまな方法でオブジェクトをアップロードしてバケットに保存できます。オブジェクトは**文字列**または**ストリーム**としてアップロードできます。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 オブジェクトに対してバージョニングを有効にしていない場合、Stratusが同じオブジェクトに対して複数の書き込みリクエストを受け取ると、オブジェクトは継続的に上書きされます。最後にアップロードされたオブジェクトのみが保存されます。 ただし、バージョニングを有効にすると、各アップロードはオブジェクトのバージョンとして扱われ、すべてが一意のversion_idを持つバケットに保存されます。 注意： パスやオブジェクトを作成する際、スペースを含む以下の文字はサポートされていません：ダブルクォート、両方の山括弧、ハッシュタグ、バックスラッシュ、パイプ記号。 ### ストリームとしてオブジェクトをアップロード このSDKメソッドを使用すると、ストリームとしてバケットにオブジェクトをアップロードできます。ストリームを変数に格納し、その変数をアップロードメソッドに渡します。 file = open('file_path','rb') res = bucket.put_object("sam/out/sample.txt",file) print(res) ### 文字列としてオブジェクトをアップロード このSDKメソッドを使用すると、文字列としてオブジェクトをアップロードできます。アップロードメソッドput_object()にオブジェクト名と、文字列形式で保存するデータを渡します。 res = bucket.put_object("sam/out/sample.txt",'content of the file') print(res) ### オプション付きでオブジェクトをアップロード このSDKメソッドを使用すると、オブジェクトをアップロードする際に以下のオプションを使用できます。 * **overwrite**: バケットの*バージョニング*が有効になっていない場合に使用できるオプションです。バージョニングなしでリソースを上書きする場合は、このオプションを使用する必要があります。デフォルト値は「**false**」です。 * **ttl**: オブジェクトの**Time-to-Live**（TTL）を秒単位で設定するために使用できるオプションです。値は**60秒**以上である必要があります。 * **meta_data**: アップロードするオブジェクトのメタ詳細をアップロードするために使用できるオプションです。 * **content_type**: オブジェクトのMIMEタイプを設定する必要がある場合に使用できるオプションです。 options = { 'overwrite': 'true', 'ttl': '300', #有効期限を秒単位で指定する 'meta_data': { 'author': 'John' } } file = open('file_path','rb') res = bucket.put_object("sam/out/sample.txt",file, options) print(res) ### 展開オプション付きでオブジェクトをアップロード 以下のメソッドを使用してzipファイルをアップロードすると、zipファイルが展開され、オブジェクトがバケットにアップロードされます。 # extract_uploadを含むアップロードオプションを定義する options = { # オブジェクトが既に存在する場合は上書きする 'overwrite': 'true', # オブジェクトが期限切れになるまでの有効期間（秒） 'ttl': '300', # ZIPファイルの内容を自動的に展開する 'extract_upload': 'true', # オブジェクトのMIMEタイプ 'content-type': 'application/zip', # オブジェクトに関連付けられたカスタムメタデータ 'meta_data': { 'author': 'Sam' } } #バイナリモードでファイルを開く file = open('sam.zip', 'rb') #ZIPの内容をアップロードして展開する res = bucket.put_object('sam/sample.zip', file, options) このSDKメソッドはtask_idを返します。このtask_idをこちらのSDKメソッドで使用して、展開のステータスを確認できます。 **レスポンス例** { 'task_id': '1234263749' } ### マルチパートを使用したオブジェクトのアップロード このセクションでは、Stratus内のバケットに大きなオブジェクトを正常にアップロードするためのSDKメソッドについて説明します。 マルチパートアップロード機能は、複数のHTTPSリクエストで大きなファイルをバケットにアップロードします。すべての個別パーツがアップロードされると、これらのリクエストはすべて単一のオブジェクトに統合されます。 注意： **100 MB以上**のオブジェクトをアップロードする場合は、マルチパートアップロードを推奨方法として検討することをお勧めします。 #### マルチパートアップロードの開始 マルチパート操作を実行するには、マルチパートオブジェクトインスタンスを取得する必要があります。Stratus内のバケットに保存されているオブジェクトに対するマルチパート操作を実行するさまざまなコードスニペットで、このコンポーネントインスタンスを参照します。 **使用するパラメータ** bucket: こちらのSDKメソッドを使用して事前に初期化したバケットインスタンスです。 init_res = bucket.initiate_multipart_upload(key="") print(init_res) **レスポンス例** { bucket: 'zcstratus123-development', key: 'objectName.txt', upload_id: '01j7xbm4vm5750zbedxqgc4q6m', status: 'PENDING' } #### オブジェクトのパーツのアップロード 以下のSDKメソッドでは、オブジェクトの個々のパーツのアップロードを実行します。各パーツには1から1000の範囲の固有のpartNumberがあります。これはパーツの順序を表しますが、これらのパーツは必ずしも順番にアップロードされるわけではありません。すべてのパーツのアップロードが完了すると、これらのパーツは順序通りに統合されます。 upload_res = bucket.upload_part(key="",upload_id="", part_number=3, body=open('file_path','rb')) print(upload_res) #### マルチパートアップロードのサマリー取得 以下のSDKメソッドを使用すると、アップロードされたすべてのパーツの操作サマリーを取得できます。サマリーを表示するには、get_multipart_upload_summary()メソッドを使用します。 summary_res = bucket.get_multipart_upload_summary(key="", upload_id="") print(summary_res) **レスポンス例** { "bucket": "zcstratus12345-development", "key": "sasm.txt", "upload_id": "01hyfyeazrrstmt7k5fa7ej726", "status": "PENDING", "parts": [ { "part_number": 1, "size": 0, "uploaded_at": 1716374678999 }, { "part_number": 2, "size": 2797094, "uploaded_at": 1716374678576 }, { "part_number": 4, "size": 0, "uploaded_at": 1716374679136 } ] } #### オブジェクトのマルチパートアップロードの完了 以下のメソッドを使用すると、すべてのパーツが正常にアップロードされた後にマルチパートプロセスを終了できます。プロセスを完了するには、complete_multipart_upload()メソッドにuploadIdを渡します。 complete_res = bucket.complete_multipart_upload(key="", upload_id="") print(complete_res) **SDK実装例** from concurrent.futures import ThreadPoolExecutor import zcatalyst_sdk def handler(request: Request): app = zcatalyst_sdk.initialize() if request.path == "/": # Stratusインスタンス stratus = app.stratus() # バケットインスタンス bucket = stratus.bucket('bucket_name') # マルチパートアップロード key = "sam/out/sample.txt" file_path = '/sam/smple.mp4' initiate_res = bucket.initiate_multipart_upload(key) part_number = 1 part_size = 50 * 1024 * 1024 futures = [] try: with open(file_path, 'rb') as file: with ThreadPoolExecutor(max_workers=3) as executor: while True: chunk = file.read(part_size) if not chunk: break futures.append(executor.submit( bucket.upload_part, key, initiate_res['upload_id'], chunk, part_number ) ) part_number += 1 for future in futures: future.result() except Exception as err: raise err multipart_upload_res = bucket.complete_multipart_upload(key, initiate_res['upload_id']) return multipart_upload_res else: response = make_response('Unknown path') response.status_code = 400 return response ### Transfer Managerを使用したオブジェクトのアップロード アップロードするオブジェクトが大きすぎてアップロードできない場合、Transfer Manager操作を実行できます。Transfer Manager操作はオブジェクトを複数のパーツに分割し、より高速なアップロードを実行します。このSDKセクションでは、Transfer Managerを使用してStratusにオブジェクトをアップロードするために利用可能なすべてのSDKメソッドについて説明します。 #### Transfer Managerインスタンスの取得 Transfer Manager操作を実行するには、Transfer Managerオブジェクトインスタンスを取得する必要があります。Stratus内のバケットに保存されているオブジェクトに対するTransfer Manager操作を実行するさまざまなコードスニペットで、このコンポーネントインスタンスを参照します。 **使用するパラメータ** bucket: こちらのSDKメソッドを使用して事前に初期化したバケットインスタンスです。 **以下のパッケージがインポートされていることを確認してください** from zcatalyst_sdk.stratus.transfer_manager import TransferManager transfer_manager = TranferManager(bucket) #### Transfer Managerを使用したオブジェクトのアップロード このセクションでは、Stratus内のバケットに大きなオブジェクトを正常にアップロードするためのSDKメソッドについて説明します。 マルチパートアップロード機能は、複数のHTTPSリクエストで大きなファイルをバケットにアップロードします。すべての個別パーツがアップロードされると、これらのリクエストはすべて単一のオブジェクトに統合されます。 注意： **100 MB以上**のオブジェクトをアップロードする場合は、マルチパートアップロードを推奨方法として検討することをお勧めします。 #### マルチパートインスタンスの作成 以下のSDKメソッドを使用して、upload_idを生成します。このIDを使用して、オブジェクトに対するマルチパート操作を実行できるインスタンスを作成して返します。 init_ins = transfer_manager.create_multipart_instance(key="") 既に初期化されたマルチパートアップロード操作のインスタンスを作成する必要がある場合は、以下のコードスニペットをコピーして使用してください。 init_ins = transfer_manager.create_multipart_instance(key="", upload_id="") #### オブジェクトのパーツのマルチパートアップロードの実行 以下のSDKメソッドでは、オブジェクトの個々のパーツのアップロードを実行します。各パーツには**1から1000**の範囲の固有のpart_numberがあります。これはパーツの順序を表しますが、これらのパーツは必ずしも順番にアップロードされるわけではありません。すべてのパーツのアップロードが完了すると、これらのパーツは順序通りに統合されます。 **使用するパラメータ** * part_number: アップロードされるパーツの順序を保持します。 * body: オブジェクトのデータ/コンテンツを保持します。 upload_res = init_ins.upload_part(body=open('file_path','rb'), part_number=3) print(upload_res) #### マルチパートアップロードのサマリー取得 以下のSDKメソッドを使用すると、アップロードされたすべてのパーツの操作サマリーを取得できます。サマリーを表示するには、get_upload_summary()メソッドを使用します。 summary_res = init_ins.get_upload_summary() print(summary_res) #### オブジェクトのマルチパートアップロードの完了 以下のメソッドを使用すると、すべてのパーツが正常にアップロードされた後にマルチパートプロセスを終了できます。プロセスを完了するには、complete_upload()メソッドにupload_idを渡します。 complete_res = init_ins.complete_upload() print(complete_res) #### Transfer Managerの全機能をラップしたオブジェクトのアップロード 以下のSDKメソッドはラッパーとして機能し、Transfer Managerのアップロード操作全体を複数のステップを使用せずに実行します。このメソッドを使用すると、オブジェクトが複数のパーツに分割され、複数のパーツでバケットにアップロードされ、すべてのパーツがアップロードされると統合されます。 注意： **2GBを超える**オブジェクトの場合は、マルチパートアップロード操作を正常に実行するために、個別のSDKメソッドを使用することをお勧めします。<br /> upload_res = transfer_res.put_object_as_parts(key='', body=open('file_path', 'rb'), part_size=50) print(upload_res) ### オブジェクトアップロード用の署名付きURLの生成 署名付きURLは、認証済みユーザーが非認証ユーザーに共有できるセキュアなURLです。このURLは、非認証ユーザーにオブジェクトへのアクセスのための一時的な認可を提供します。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトのパスを含む完全な名前を保持します。</td> </tr> <tr> <td>url_action</td> <td>Request Method</td> <td>必須パラメータです。アップロード（PUT）アクション用の署名付きURLを生成するためのパラメータです。 <ul> <li>**PUT**: オブジェクトをアップロードする場合</li> </ul> </td> </tr> <tr> <td>expiry</td> <td>String</td> <td>任意パラメータです。URLの有効期間（秒単位）です。 <ul> <li>デフォルト値: 3600秒</li> <li>最小値: 30秒</li> <li>最大値: 7日間</li> </ul> </td> </tr> <tr> <td>active_from</td> <td>String</td> <td>任意パラメータです。URLが有効になる時刻を保持します。最大値は7日間です。デフォルトでは、URLは生成されるとすぐに有効になります。</td> </tr> </tbody> </table> pre_signed_url_res = bucket.generate_presigned_url("sam/out/sample.txt",url_action='PUT',expiry_in_sec='300', active_from='1023453725828') print(pre_signed_url_res) **アップロード用署名付きURL生成のレスポンス例** { "signature": "https://sadi-development.zohostratus.com/_signed/code.txt?organizationId=96862383&stsCredential=96858154-96862383&stsDate=1747899245773&stsExpiresAfter=300&stsSignedHeaders=host&stsSignature=YBPoNE9txCIUWWX3ntdgVd95VTt1jGFlSuvnTRFbCMQ" file_path = "/Users/ranjitha-18338/Documents/Pyhton-SDK/filestore2.0/output.txt", "expiry_in_seconds": "300", "active_from": "1726492859577" } **署名付きURLを使用したオブジェクトアップロードのスニペット例** import requests #実際の署名付きURLに置き換える url = "https://sadi-development.zohostratus.com/_signed/code.txt?organizationId=96862383&stsCredential=96858154-96862383&stsDate=1747899245773&stsExpiresAfter=300&stsSignedHeaders=host&stsSignature=YBPoNE9txCIUWWX3ntdgVd95VTt1jGFlSuvnTRFbCMQ" #アップロードするローカルファイルのパス file_path = "file_path" #必須ヘッダーを設定する headers = { # 'Content-Type': 'text/plain', # ファイルのコンテンツタイプを指定する # 'overwrite': 'true', # 上書きを示すオプションのカスタムヘッダー（サーバーで必要な場合） } #バイナリ読み取りモードでファイルを開き、PUTリクエストを送信してアップロードする with open(file_path, 'rb') as f: files = {'file': f} #ファイルペイロードを作成する response = requests.put(url, headers=headers, files=files) #レスポンスステータスを確認する if response.status == 200: print('Object uploaded successfully') else: print('Object upload failed') -------------------------------------------------------------------------------- title: "Zipオブジェクトの展開" description: "このページでは、Zipオブジェクトを展開するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.355Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/extract-zipped-object/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/extract-zipped-object/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/extract-zipped-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Zipオブジェクトの展開 以下のSDKメソッドを使用すると、Stratus内でzipファイルを展開でき、zipファイル内に存在する個々のコンテンツはそれぞれ個別のオブジェクトとしてStratus内の同じバケットにアップロードされます。このプロセス全体は*非同期的*に実行されます。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 注意： 展開プロセスは非同期的に実行されるため、プロセス全体の完了にかかる時間は、展開されるzipファイルのサイズに依存します。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。展開するzipファイルの名前です。</td> </tr> <tr> <td>destination</td> <td>String</td> <td>必須パラメータです。展開されたオブジェクトがバケット内に保存される宛先の完全なパス情報を保持します。</td> </tr> </tbody> </table> unzip_res = bucket.unzip_object("sam/out/sample.zip","output/") print(unzip_res) #### レスポンス例 { "key": "sam/out/sample.zip", "destination": "output/", "task_id": "6963000000272049", "message": "Zip extract scheduled" } ### Zip展開ステータスの取得 zip展開プロセスは非同期的に実行され、展開プロセスの完了にかかる時間はzipファイルのサイズに大きく依存します。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 以下のSDKメソッドでtask_idパラメータを使用すると、展開のステータスを確認できます。task_idはunzip_object()メソッドのレスポンスで返されます。 res = bucket.get_unzip_status("sam/out/sample.zip", 'task_id') print(res) #### レスポンス例 { "task_id": "6963000000272049", "status": "SUCCESS" } -------------------------------------------------------------------------------- title: "オブジェクトのコピー" description: "このページでは、バケット内でオブジェクトのコピーを作成するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.356Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/copy-objects/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/copy-objects/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/copy-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトのコピー このSDKメソッドを使用すると、バケット内でオブジェクトをコピーして貼り付けることができます。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 keyはコピーするオブジェクトで、destinationにはコピーされたオブジェクトの新しい名前が含まれます。コピーしたオブジェクトを別のパスに貼り付けるには、dest_objectとして完全なパス名を指定する必要があります。 注意： * keyとdestinationの両方の値に、パスを含む完全なオブジェクト名を指定する必要があります。 * 例えば、パスpictures/puppyに「kitten.png」というファイルがあり、pictures/kittenパスにコピーする必要がある場合：<br /> keyの値は「pictures/puppy/kitten.png」になります<br /> destinationの値は「pictures/kitten/kitten.png」になります<br /> res = bucket.copy_object("sam/out/sample.txt","output/sample.txt") print(res) #### レスポンス例 { "copy_to": "output/sample.txt", "object_key": "sam/out/sample.txt", "message": "Object copied successfully." } -------------------------------------------------------------------------------- title: "オブジェクトの名前変更と移動操作" description: "このページでは、オブジェクトの名前変更と移動操作を実行するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.356Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/rename-move-object/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/rename-move-object/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/rename-move-object/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトの名前変更と移動操作 オブジェクトの名前変更と移動には、同じrename_object() SDKメソッドを使用します。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>名前を変更するオブジェクトの元の名前です</td> </tr> <tr> <td>destination</td> <td>String</td> <td>オブジェクトの変更後の新しい名前です</td> </tr> </tbody> </table> 注意： * sourceObjectとdestObjectの両方の値に、パスを含む完全なオブジェクト名を指定する必要があります。 * 例えば、パスpictures/puppyに「kitten.png」というファイルがあり、pictures/kittenパスに移動または名前変更する必要がある場合：<br /> keyの値は「pictures/puppy/kitten.png」になります<br /> destinationの値は「pictures/kitten/kitten.png」になります<br /> ### オブジェクトの名前変更 rename_object() SDKメソッドを使用すると、バケット内に存在するオブジェクトの名前を変更できます。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 注意： * バージョニングが有効なバケットではオブジェクトの名前を変更できません。 * パスやオブジェクトを作成する際、スペースを含む以下の文字はサポートされていません：ダブルクォート、両方の山括弧、ハッシュタグ、バックスラッシュ、パイプ記号。 rename_res = bucket.rename_object("sam/out/sample.txt","sam/out/update_sample.txt") print(rename_res)<br /> #### レスポンス例 { "current_key": "sam/out/sample.txt", "message": "Rename successful", "rename_to": "sam/out/update_sample.txt" } ### オブジェクトの移動 rename_object() SDKメソッドを使用すると、バケット内のあるパスから別のパスにオブジェクトを移動できます。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 rename_res = bucket.rename_object("sam/out/sample.txt","output/sample.txt") print(rename_res)<br /> 注意： バージョニングが有効なバケットでは移動操作を実行できません。 #### レスポンス例 { "current_key": "sam/out/sample.txt", "message": "Rename successful", "rename_to": "sutput/sample.txt" } -------------------------------------------------------------------------------- title: "オブジェクトの削除" description: "このページでは、バケットに保存されているオブジェクトを削除するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.356Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/delete-objects/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/delete-objects/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/delete-objects/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/delete-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/delete-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/delete-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/delete-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトの削除 以下のSDKメソッドを使用すると、Stratusで削除操作を実行できます。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトのパスを含む完全な名前を保持します。</td> </tr> <tr> <td>version_id</td> <td>String</td> <td>任意パラメータです。バケットでバージョニングが有効な場合、このパラメータを使用して一意のバージョンIDで特定のバージョンを参照できます。</td> </tr> <tr> <td>ttl</td> <td>int</td> <td>任意パラメータです。削除操作をスケジュールできます。例えば、ttlの値を60に設定すると、削除操作は60秒後に実行されます。ttlの値は60秒以上である必要があります。</td> </tr> </tbody> </table> ### 単一オブジェクトの削除 このSDKメソッドを使用すると、delete_object()メソッドにオブジェクト名を渡して特定のオブジェクトを削除できます。 delete_res = bucket.delete_object("sam/out/sample.txt") print(delete_res) 注意： バケットでバージョニングが有効で、特定のversion_idが指定されていない場合、オブジェクトを削除すると、デフォルトでそのオブジェクトのすべてのバージョンが削除されます。 ### 指定時間後にオブジェクトの特定バージョンを削除 バケットでバージョニングを有効にしている場合、オブジェクトのversionIdを指定してください。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 ttl変数を使用して削除操作をスケジュールすることもできます。例えば、ttlの値を**100**に設定すると、削除操作は**100秒後**に実行されます。ttlの値は常に**60秒**以上であることを確認してください。 delete_res = bucket.delete_object("sam/out/sample.txt", 'version_id', ttl=300) print(delete_res) ### 複数オブジェクトの削除 このSDKメソッドを使用すると、削除するオブジェクトの名前を配列として渡して複数のオブジェクトを削除できます。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 バケットでバージョニングを有効にしている場合、オブジェクトのversionIdを指定してください。ttl変数を使用して削除操作をスケジュールすることもできます。例えば、ttlの値を**100**に設定すると、削除操作は**100秒後**に実行されます。ttlの値は常に**60秒**以上であることを確認してください。 delete_objects_res = bucket.delete_objects([ { 'key' : "sam/out/sample.txt", 'version_id':'01hj6ackcxpha9151n7mj0cq6g' }, { 'key' :"sam/out/sample1.txt", 'version_id':'01hj68v1tmb33wa7zchb1vtbjn' }],ttl=300) print(delete_objects_res) #### 削除操作のレスポンス例 {'message': 'Object Deletion successful.'} ### バケットのトランケート このSDKメソッドを使用すると、バケット内に存在するすべてのオブジェクトを削除できます。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 # バケット内のすべてのオブジェクトを削除する truncate_res = bucket.truncate() print(truncate_res) ### バケット内のパスの削除 このSDKを使用すると、パス内に存在するすべてのオブジェクトを削除できます。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 delete_path()メソッドに完全なパスを渡す必要があります。 path_res = bucket.delete_path("sam/") print(path_res)<br /> 注意： 正確なパスを指定してください。誤ったパスが指定された場合、削除アクションはスケジュールされますが、エラーが発生します。 #### レスポンス例 { "path": "sam/", "message": "Path deletion scheduled" } -------------------------------------------------------------------------------- title: "オブジェクトインスタンスの作成" description: "このページでは、オブジェクトインスタンスを作成するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.356Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/create-object-instance/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/create-object-instance/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/create-object-instance/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトインスタンスの作成 オブジェクト関連の操作を実行するためのオブジェクトインスタンスを取得するには、以下のメソッドを使用します。以下のコードスニペットで使用されているBucketの参照は、コンポーネントインスタンスです。 object_ins = bucket.object("sam/out/sample.txt") -------------------------------------------------------------------------------- title: "オブジェクトバージョンの一覧取得" description: "このページでは、オブジェクトのバージョンを取得するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.356Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/list-object-versions/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/get-object-versions/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/get-object-versions/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトバージョンの一覧取得 ### ページネーションによるオブジェクトのすべてのバージョンの一覧取得 バケットでバージョニングを有効にすると、同じオブジェクトの複数のバージョンをバケットに保存できます。オブジェクトの各バージョンには独自のversionIdがあります。このSDKメソッドを使用すると、バケット内に存在するオブジェクトのすべての既存バージョンをページネーションで取得できます。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>next_token</td> <td>String</td> <td>次のバージョンセットを取得するための値を保持します。</td> </tr> <tr> <td>max_versions</td> <td>int</td> <td>任意パラメータです。各イテレーションで一覧取得できるオブジェクトのバージョンの最大数の値を保持します。</td> </tr> </tbody> </table> def list_my_paged_versions(max_versions = None, next_token= None): res = object_ins.list_paged_versions(max_versions, next_token) print(res) if not res['is_truncated']: # オブジェクトのバージョンがさらにある場合は'true'を返す。それ以上バージョンがない場合は'false'を返す return list_my_paged_versions(max_versions, next_token) list_my_paged_versions(2) #### レスポンス例 { "key": "downloaded_file.json", "versions_count": 2, "max_versions": "2", "is_truncated": "False", "next_continuation_token": "4YpUdkktt2UeWp6MwEK1LZXELnuVhunHLnGgX29uvszwtJEQE2gVDJYyRiLdUmhNst", "version": [ { "version_id": "01hyfh12njtpyvzwq6p1fd2d8s", "is_latest": "True", "last_modified": "May 22, 2024 12:20 PM", "size": 1, "etag": "9af7c117d9de9a06fba7a5f1ea5fcc2d" }, { "version_id": "01hyfh0xkvwkxxsjfceef201xa", "is_latest": "False", "last_modified": "May 22, 2024 12:20 PM", "size": "1", "etag": "9af7c117d9de9a06fba7a5f1ea5fcc2d" } ] } ### イテレーションによるオブジェクトのすべてのバージョンの一覧取得 以下のSDKメソッドを使用すると、単一の呼び出しでオブジェクトの利用可能なすべてのバージョンを取得できます。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 versions = object_ins.list_iterable_versions(2) for key in versions: print(key) #### レスポンス例 { "version_id": "01hyfh12njtpyvzwq6p1fd2d8s", "is_latest": "True", "last_modified": "May 22,2024 12:20 PM", "size": "1", "etag": "9af7c117d9de9a06fba7a5f1ea5fcc2d" } { "version_id": "01hyfh0xkvwkxxsjfceef201xa", "is_latest": "False", "last_modified": "May 22, 2024 12:20 PM", "size": "1", "etag": "9af7c117d9de9a06fba7a5f1ea5fcc2d" } -------------------------------------------------------------------------------- title: "オブジェクト詳細の取得" description: "このページでは、バケットに保存されているオブジェクトの詳細を取得するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.356Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/object-details/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/object-details/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/object-details/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクト詳細の取得 ### オブジェクトの詳細取得 バケットに保存されているオブジェクトの詳細を取得するには、以下のSDKメソッドを使用します。以下のコードスニペットで使用されているObjectの参照は、コンポーネントインスタンスです。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 res = object_ins.get_details() print(res) 注意： バージョニングが有効な場合、このSDKメソッドを使用すると、最新バージョンのオブジェクト詳細のみが返されます。 #### レスポンス例 { "key": "sam/out/sample.txt", "size": 1, "content_type": "text/plain", "last_modified": "May 22, 2024 12:25 PM", "meta_data": { "author": "John" }, "object_url": "https://zcstratus12345-development.zohostratus.com/sam/out/sample.txt", "cached_object_url": "https://zcstratus12345-development.nimbuslocaledge.com/sam/out/sample.txt" } ### オブジェクトの特定バージョンの詳細取得 このSDKメソッドを使用すると、特定のオブジェクトのバージョンのすべての詳細を取得できます。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>version_id</td> <td>String</td> <td>任意パラメータです。バケットでバージョニングが有効な場合、このパラメータを使用して一意のバージョンIDで特定のバージョンを参照できます。</td> </tr> </tbody> </table> 注意: * このメソッドを使用するには、オブジェクトのバージョニングを少なくとも一度有効にしている必要があります。 * バージョニングの詳細については、こちらのヘルプドキュメントをご覧ください。 res = object_ins.get_details('version_id') print(res) #### レスポンス例 { "key": "sample.txt", "version_id": "01j7xgnmv5dhpk45kn3pctkasp", "size": 16, "content_type": "text/plain", "etag": "ad6affccd08876ad9ae5f60b7848b2c7", "last_modified": "Sep 16, 2024 07:04 PM", "object_url": "https://zcstratus123-development.zohostratus.com/sample.txt", "cached_object_url": "https://zcstratus123-development.nimbuslocaledge.com/sample.txt", } -------------------------------------------------------------------------------- title: "オブジェクトメタデータの設定" description: "このページでは、オブジェクトにメタデータを追加するためのPython SDKメソッドを説明します。" last_updated: "2026-06-10T06:04:54.357Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/stratus/put-object-meta/" service: "Cloud Scale" related: - Stratusコンポーネントヘルプドキュメント (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/put-object-meta/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/put-object-meta/) - Web SDK (/ja/sdk/web/v4/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトメタデータの設定 以下のSDKメソッドを使用すると、Stratus内のバケットに保存されている特定のオブジェクトにメタ詳細を追加できます。以下のコードスニペットで使用されているObjectの参照は、コンポーネントインスタンスです。 情報： このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションをご覧ください。 メタ詳細はJSONキーバリューペアとして渡されます。例：{"meta_key" : "meta_value"} res = object_ins.put_meta({'author': 'Amelia Burrows'}) print(res) 注意： * 既存の詳細を追加せずにこのメソッドを使用して新しいメタ詳細を渡すと、既存の詳細が削除され、新しい詳細のみが設定されます。これを避けるには、既存のメタ詳細とともに新しいメタ詳細を渡してください。 * メタデータの記述には、英数字、アンダースコア、空白文字、およびハイフンを使用できます。それ以外の特殊文字は使用できません。 * **HEAD**リクエストメソッドを使用してオブジェクトのメタデータを取得できます。レスポンスでは、メタデータはキー「x-user-meta」にリストされます。 * メタデータ全体の最大サイズ制限は**2047**文字です。サイズ制限を決定するために使用される文字数には、キーバリューペアを定義するために使用されるコロン「:」特殊文字も含まれます。 #### レスポンス例 { "message": "Metadata added successfully" } ##### ZCQL -------------------------------------------------------------------------------- title: "ZCQL インスタンスの取得" description: "このページでは、PythonアプリケーションでData StoreのテーブルにZCQLクエリを実行するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.357Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/zcql/get-component-instance/" service: "Cloud Scale" related: - ZCQL Help (/ja/cloud-scale/help/zcql/introduction) - Data Store Help (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # ZCQL Catalyst Cloud Scale ZCQLは、Catalyst Cloud Scale Data Storeのテーブルに対してデータの取得、挿入、更新、削除操作を実行できるCatalyst独自のクエリ言語です。ZCQLを使用してさまざまなDMLクエリを実行してデータを取得または操作し、SQL Joinクエリ、GroupByおよびOrderByステートメント、組み込みSQL関数などのさまざまな句やステートメントを使用できます。 Catalystでは、分析データ取得クエリに適したプライマリData Storeに加えて、**OLAPデータベース**も提供しています。プライマリData Storeでシンプルなトランザクションクエリを実行し、OLAPデータベースでZCQL関数を含む複雑な分析クエリを実行することができます。 ### コンポーネントインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに固有の事前定義された設定にアクセスするために使用できるオブジェクトです。この処理はサーバーサイドの呼び出しを発行しません。 以下のコードで使用されているapp参照は、SDK初期化時にレスポンスとして返されるPythonオブジェクトです。また、このインスタンスは、Catalyst Data Storeでの取得、挿入、更新、または削除操作を実行する際の複数のシナリオで使用されることに注意してください。 #ZCQLコンポーネントインスタンスを取得する zcql_service = app.zcql() -------------------------------------------------------------------------------- title: "クエリの実行" description: "このページでは、PythonアプリケーションでData StoreのテーブルにZCQLクエリを実行するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.357Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/zcql/execute-zcql-query/" service: "Cloud Scale" related: - Execute query - API (/ja/api/code-reference/cloud-scale/zcql/execute-zcql-query/#ExecuteZCQLQuery) - ZCQL Help (/ja/cloud-scale/help/zcql/introduction) - Data Store Help (/ja/cloud-scale/help/data-store/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # クエリの実行 以下のコードスニペットで使用されているzcql_service参照は、以前に作成されたコンポーネントインスタンスです。渡されるクエリオブジェクトに基づいて、レスポンスは行オブジェクトまたは行オブジェクトの配列を返します。 ### プライマリData Storeでのクエリの構築と実行 プライマリData Storeで実行するZCQLクエリでは、以下に示すようにクエリオブジェクトを構築し、execute_query()メソッドに渡すことができます。これらのクエリには、SELECT、INSERT、UPDATE、またはDELETEステートメントを含めることができます。 サンプルINSERTクエリを以下に示します： #ZCQLクエリを構築する query = 'INSERT into ShipmentData (productID, productName, region) VALUES (3782, A4 Reams, India)' result = zcql_service.execute_query(query) ### OLAPデータベースでのクエリの構築と実行 OLAPデータベースで実行するクエリには、SELECTステートメントのみを含める必要があります。直接の書き込み操作は許可されていません。クエリオブジェクトを構築し、execute_olap_query()メソッドに渡すことができます。サンプルの分析SELECTクエリを以下に示します。 //Construct the query to execute query = 'SELECT SUM(price) FROM ShipmentData'; result = zcql_service.execute_olap_query(query); **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>query</td> <td>String</td> <td>必須パラメータです。実行するクエリを格納します。</td> </tr> </tbody> </table> 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 ##### メール -------------------------------------------------------------------------------- title: "Mail インスタンスの取得" description: "このページでは、Pythonアプリケーションからエンドユーザーにメールを送信するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.357Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/mail/get-component-instance/" service: "Cloud Scale" related: - Mail Help (/ja/cloud-scale/help/mail/introduction) -------------------------------------------------------------------------------- # Catalyst Mail Catalyst Mailでは、Catalystアプリケーションからエンドユーザーにメールを送信するために使用するビジネスのメールアドレスを追加できます。パブリックドメインまたは組織独自のドメインのメールアドレスを設定できます。また、組み込みのCatalystメールクライアントを使用する代わりに、任意の外部メールクライアントを使用し、そのSMTP設定をCatalystで構成することもできます。このセクションでは、アプリケーションでCatalyst Mail機能を実装するために使用できるさまざまなSDKメソッドについて説明します。 ### コンポーネントインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに固有の事前定義された設定にアクセスするために使用できるオブジェクトです。この処理はサーバーサイドの呼び出しを発行しません。 以下のコードで使用されているapp参照は、SDK初期化時にレスポンスとして返されるPythonオブジェクトです。以下に示すように、新しいmail_serviceインスタンスを作成できます。また、このコンポーネントインスタンスは、アプリケーションでCatalyst Mailサービスを実装する際の複数のシナリオで使用されることに注意してください。 #Mailコンポーネントインスタンスを取得する mail_service = app.email() -------------------------------------------------------------------------------- title: "メールの送信" description: "このページでは、Pythonアプリケーションからエンドユーザーにメールを送信するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.357Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/mail/send-email/" service: "Cloud Scale" related: - Send Email - API (/ja/api/code-reference/cloud-scale/mail/send-email/#SendEmail) - Mail Help (/ja/cloud-scale/help/mail/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # メール送信 コンソールから、任意のメールクライアントのドメイン、メールアドレス、およびSMTP設定を構成する必要があります。ここに示すコードにより、Catalystアプリケーションから指定したメールアドレスにメールを送信できます。 Catalystでは、1回のメール送信操作で、複数のメールアドレスを受信者として設定し、CC、BCC、返信先を設定できます。メールにファイルを添付することもできます。1回のメール送信操作でサポートされるメール受信者とファイル添付の最大制限は以下のとおりです： * 宛先アドレス： 10 * CC： 10 * BCC： 5 * 返信先： 5 * 添付ファイル数： 5 * 添付ファイルサイズ： 15 MB（単一ファイルまたは最大5ファイルの合計） 注意： 件名、送信者、および少なくとも1つの受信者メールアドレスは必須です。メールのその他の属性は任意です。 #### 辞書の作成 最初に、メールの必要な属性を含む辞書を作成する必要があります。これには、送信者のメールアドレスとメールのすべての受信者が含まれます。 まず、Catalystコンソールで送信者のメールアドレスを設定し、確認する必要があります。送信者のメールがプライベートドメインでホストされている場合、またはサードパーティのメールクライアントを使用する場合は、メール送信前にそれらも設定する必要があります。 #辞書を作成する mail_obj = { 'from_email': 'emma@zylker.com', 'to_email': ["vanessa.hyde@zoho.com"], 'cc': ["robert.plant@zylker.com"], 'bcc': ["ham.gunn@zylker.com", "rover.jenkins@zylker.com"], 'reply_to': ["peter.d@zoho.com", "arnold.h@zoho.com"], 'subject': 'Greetings from Zylker Corp!', 'attachments': [file1], 'content': "<p>Hello,</p> We're glad to welcome you at Zylker Corp. To begin your journey with us, please download the attached KYC form and fill in your details. You can send us the completed form to this same email address.</p>We cannot wait to get started!<p><p>Cheers!</p><p>Team Zylker</p>" } ### メール送信 以下のコードに示すように、設定した辞書をsend_mail()メソッドの引数として渡す必要があります。これにより、メール送信プロセスが開始されます。以下で使用されているコンポーネントインスタンスmail_serviceの詳細については、こちらのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>mail_obj</td> <td>Object</td> <td>必須パラメータです。送信者のメールアドレス、受信者のメールアドレス、CC、BCC、返信先アドレス、件名、添付ファイル、およびメール本文の詳細を格納します。</td> </tr> </tbody> </table> #メールを送信する mail_service = app.email() response = mail_service.send_mail(mail_obj) サンプルレスポンスを以下に示します： { isAsync: false, project_details: { project_name: "Onboarding", id: "2136000000007733" }, from_email: ["emma@zylker.com"], to_email: ["vanessa.hyde@zoho.com"], cc:["robert.plant@zylker.com"], bcc:["ham.gunn@zylker.com","rover.jenkins@zylker.com"], reply_to:["peter.d@zoho.com","arnold.h@zoho.com"], html_mode: true, subject: "Greetings from Zylker Corp!", content: "<p>Hello,</p> We're glad to welcome you at Zylker Corp. To begin your journey with us, please download the attached KYC form and fill in your details. You can send us the completed form to this same email address.</p>We cannot wait to get started!<p><p>Cheers!</p><p>Team Zylker</p>" } 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 ##### キャッシュ -------------------------------------------------------------------------------- title: "キャッシュインスタンスの取得" description: "このページでは、Pythonアプリケーションでキーまたはキャッシュオブジェクトを使用してキーバリューペアを削除する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.357Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/cache/get-component-instance/" service: "Cloud Scale" related: - Cache Help (/ja/cloud-scale/help/cache/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # キャッシュ Catalyst Cloud Scaleキャッシュは、メインのデータストレージユニットとは独立して使用できる一時的なストレージコンポーネントとして提供されます。動的でメモリを多く使用するアプリケーションに実装すると非常に便利です。Catalystキャッシュは、以下に記載されているSDKメソッドを使用してアプリケーションに実装できます。 # コンポーネントインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに関する定義済みの設定にアクセスするために使用できるオブジェクトです。このプロセスはサーバーサイドの呼び出しを発生させません。 以下のコードで使用されているappの参照は、SDK初期化時にレスポンスとして返されるPythonオブジェクトです。以下のように新しいcache_serviceインスタンスを作成できます。このインスタンスは、キャッシュコンポーネント関連の操作を実行する際のさまざまなシナリオで使用されます。 #Cacheコンポーネントインスタンスを取得する cache_service = app.cache() -------------------------------------------------------------------------------- title: "セグメントインスタンスの取得" description: "このページでは、Pythonアプリケーションでキャッシュセグメントインスタンスを取得する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.357Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/cache/get-segment-instance/" service: "Cloud Scale" related: - Cache Help (/ja/cloud-scale/help/cache/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # セグメントインスタンスの取得 以下で使用されているコンポーネントインスタンスcache_serviceの詳細については、こちらのセクションを参照してください。 セグメントIDがパラメータとして渡された場合、キャッシュの実装はその特定のセグメントを参照します。セグメントIDが明示的に指定されない場合は、デフォルトのセグメントを参照します。 #セグメントインスタンスを取得する cache_service = app.cache() segment_service = cache_service.segment() -------------------------------------------------------------------------------- title: "キャッシュからのデータ取得" description: "このページでは、Pythonアプリケーションでキャッシュからデータを取得する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.357Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/cache/retrieve-data-from-cache/" service: "Cloud Scale" related: - Retrieve Data from the Cache - API (/ja/api/code-reference/cloud-scale/cache/get-cache-value/#GetCacheValue) - Cache Help (/ja/cloud-scale/help/cache/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # キャッシュからのデータ取得 ### キャッシュ値の取得 Catalyst Cloud Scaleキャッシュは、セグメントと呼ばれるパーティションまたはキャッシュユニットに分割されています。各セグメントは、キーバリューペアの形式でキャッシュアイテムを格納します。キーと値はどちらもString型です。 get_value()メソッドを使用して、キャッシュ内のセグメントからキャッシュアイテムの値を取得できます。キー名を引数として渡す必要があり、そのキーに対応する値がレスポンスとして返されます。 以下で使用されているコンポーネントインスタンス cache_serviceおよびsegment_service segment_serviceの詳細については、それぞれのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>Key</td> <td>String</td> <td>必須パラメータです。キャッシュ値を取得するためのキーを保持します。</td> </tr> </tbody> </table> #キャッシュ値を取得する cache_service = app.cache() segment_service = cache_service.segment() data = segment_service.get_value('key') サンプルレスポンスを以下に示します： { "cache_name": "Name", "cache_value": "Amelia Burrows", "expires_in": "Mar 09, 2023 06:20 PM", "expiry_in_hours": "48", "project_details": { "id": "2648000001343001", "project_name": "appEngine", "project_type": "Live", }, "segment_details": {"id": "2648000001343037", "segment_name": "Default"}, "ttl_in_milliseconds": "172800000", } ### キャッシュオブジェクトの取得 キーバリューペアがディクショナリ型であるキャッシュの詳細を取得できます。キーオブジェクトはget()メソッドを使用して取得します。キー名を引数として渡します。 以下で使用されているコンポーネントインスタンス cache_serviceおよびセグメントインスタンス segment_serviceの詳細については、それぞれのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>cache_name</td> <td>String</td> <td>必須パラメータです。キャッシュオブジェクトを取得するためのキーを保持します。</td> </tr> </tbody> </table> cache_service = app.cache() segment_service = cache_service.segment() data = segment_service.get('key') サンプルレスポンスを以下に示します： { cache_name: "Name", cache_value: "Amelia Burrows", project_details: { project_name: "AlienCity", id: "2136000000007733" }, segment_details: { segment_name: "Location", id: "2136000000008572" }, expires_in: "Aug 18, 2021 06:39 PM", expiry_in_hours: "47", ttl_in_milliseconds: "172727000" } 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "キャッシュへのデータ挿入" description: "このページでは、Pythonアプリケーションでキャッシュにデータを挿入する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.357Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/cache/insert-data-into-cache/" service: "Cloud Scale" related: - Insert Data to Cache - API (/ja/api/code-reference/cloud-scale/cache/insert-key-value-in-segment/#InsertKey-ValueinCacheSegment) - Cache Help (/ja/cloud-scale/help/cache/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # キャッシュへのデータ挿入 put()メソッドを使用してキャッシュ要素を挿入できます。これにより、Catalystプロジェクトの既存のキャッシュセグメントにキーバリューペアを挿入できます。キー名とキー値はString型で、メソッドの引数として渡されます。 また、オプションで有効期限パラメータを渡すこともできます。値が明示的に指定されない場合、有効期限はデフォルトで48時間に設定されます。 以下で使用されているコンポーネントインスタンス cache_serviceおよびセグメントインスタンス segment_serviceの詳細については、それぞれのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>cache_name</td> <td>String</td> <td>必須パラメータです。キャッシュに挿入するキーを保持します。</td> </tr> <tr> <td>cache_value</td> <td>String</td> <td>必須パラメータです。キャッシュに挿入する値を保持します。</td> </tr> <tr> <td>expiry_in_hours</td> <td>Numeric</td> <td>任意パラメータです。データの有効期限の値を保持します。</td> </tr> </tbody> </table> # Insert Data to Cache cache_service = app.cache() segment_service = cache_service.segment() segment_service.put('Name', 'Smith',2) サンプルレスポンスを以下に示します： { cache_name: "Name", cache_value: "Smith", project_details: { project_name: "AlienCity", id: "2136000000007733" }, segment_details: { segment_name: "Location", id: "1234324234" }, expires_in: "Aug 18, 2021 06:46 PM", expiry_in_hours: "2", ttl_in_milliseconds: "172800000" } 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "キャッシュ内のデータ更新" description: "このページでは、Pythonアプリケーションでキャッシュ内のデータを更新する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.358Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/cache/update-data-in-cache/" service: "Cloud Scale" related: - Update Data in Cache - API (/ja/api/code-reference/cloud-scale/cache/update-key-value/#UpdateKey-ValuePair) - Cache Help (/ja/cloud-scale/help/cache/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # キャッシュ内のデータ更新 update()メソッドを使用して、キャッシュセグメント内のキーバリューペアを更新できます。String型のキー名とキー値を引数として渡す必要があります。値が存在しない場合は、キャッシュセグメントに挿入されます。 また、オプションで有効期限パラメータを渡すこともできます。値が明示的に指定されない場合、有効期限はデフォルトで48時間に設定されます。 以下で使用されているコンポーネントインスタンス cache_serviceおよびセグメントインスタンスsegment_serviceの詳細については、それぞれのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>cache_name</td> <td>String</td> <td>必須パラメータです。キャッシュ内で更新するキーを保持します。</td> </tr> <tr> <td>cache_value</td> <td>String</td> <td>必須パラメータです。キャッシュ内で更新するキーの値を保持します。</td> </tr> </tbody> </table> #キャッシュ内のデータを更新する cache_service = app.cache() segment_service = cache_service.segment() segment_service.update('Name', 'Michael Scott') サンプルレスポンスを以下に示します： { cache_name: "Name", cache_value: "Michael Scott", project_details: { project_name: "AlienCity", id: "2136000000007733" }, segment_details: { segment_name: "Data Store", id: "2136000000008572" }, expires_in: "Aug 18, 2021 06:46 PM", expiry_in_hours: "47", ttl_in_milliseconds: "172596000" } 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "キーバリューペアの削除" description: "このページでは、Pythonアプリケーションでキーまたはキャッシュオブジェクトを使用してキーバリューペアを削除する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.358Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/cache/delete-key-value-pair/" service: "Cloud Scale" related: - Cache Help (/ja/cloud-scale/help/cache/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # キーバリューペアの削除 キーバリューペアが不要になった場合、キャッシュセグメントから完全に削除できます。キーバリューペアは一度削除すると復元できません。 以下で使用されているコンポーネントインスタンスcomponent_serviceおよびセグメントインスタンス segment_serviceの詳細については、それぞれのヘルプセクションを参照してください。 ### キーを使用した削除 delete()メソッドにキー名を直接パラメータとして渡すことで、キーバリューペアを削除できます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。キャッシュセグメントのキー名を保持します。</td> </tr> </tbody> </table> #キーバリューペアを削除する cache_service = app.cache() segment_service = cache_service.segment() segment_service.delete('Name') 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 ##### プッシュ通知 -------------------------------------------------------------------------------- title: "プッシュ通知インスタンスの取得" description: "このページでは、Pythonアプリケーションからエンドユーザーにリモート通知を送信するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.358Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/push-notifications/get-component-instance/" service: "Cloud Scale" related: - Push Notifications Help (/ja/cloud-scale/help/push-notifications/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Push Notifications Catalyst Cloud Scale Push notificationsを使用すると、ユーザーデバイスでアプリがアクティブに実行されていない場合でも、アプリケーションのユーザーにリモート通知を送信できます。特定のターゲットユーザーリストにプッシュ通知を送信できます。ユーザーがアプリケーションに関与するためのアラート、アップデート、またはプロモーションコンテンツを含めることができます。 プッシュ通知を送信する前に、ユーザーが許可した際にWebアプリでプッシュ通知を有効にする必要があります。これは、Webクライアントにこのコードスニペットを実装することで行えます。CatalystリモートコンソールのPush Notificationsセクションからこのコードにアクセスすることもできます。Web初期化スクリプトを含めることを確認してください。 #### コンポーネントインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに固有の事前定義された設定にアクセスするために使用できるオブジェクトです。この処理はサーバーサイドの呼び出しを発行しません。 以下のコードで使用されているapp参照は、SDK初期化時にレスポンスとして返されるPythonオブジェクトです。以下に示すように、新しいpush_notification_serviceインスタンスを作成できます。このコンポーネントインスタンスは、Catalystアプリケーションからプッシュ通知を送信する際に参照します。 #Push Notificationインスタンスを取得する push_notification_service = app.push_notification() -------------------------------------------------------------------------------- title: "ウェブアプリへの通知送信" description: "このページでは、Pythonアプリケーションからエンドユーザーにリモート通知を送信するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.358Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/push-notifications/send-notifications/" service: "Cloud Scale" related: - Send Notifications - API (/ja/api/code-reference/cloud-scale/push-notifications/web/send-web-push-notifications/#SendWebNotifications) - Push Notifications Help (/ja/cloud-scale/help/push-notifications/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Webアプリへのプッシュ通知送信 Catalystでは、1回の関数呼び出しで50ユーザーにプッシュ通知を送信できます。以下に示すように、通知を送信するすべてのユーザーのユーザーIDを配列に追加できます。次に、通知に含めるメッセージ文字列とともに、配列をsend_notification()メソッドに渡す必要があります。この文字列には、プレーンテキスト、HTML、またはパースされるJSONオブジェクトを使用できます。 以下で使用されているコンポーネントインスタンスpush_notification_serviceの詳細については、こちらのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>notification_message</td> <td>String</td> <td>必須パラメータです。通知メッセージを格納します。</td> </tr> <tr> <td>user_list</td> <td>Array</td> <td>必須パラメータです。通知を送信するユーザーのIDまたはメールアドレスを格納します。</td> </tr> </tbody> </table> #ユーザーIDを使用してプッシュ通知を送信する push_notification_service = app.push_notification() user_list = [1234556789098, 6756467677890] logging.info(push_notification_service.web().send_notification("Hi there! The task you scheduled has been completed.", user_list)) ユーザーIDの代わりにメールアドレスを含めて、ユーザーに通知を送信することもできます。メールアドレスを配列に追加し、同じ方法でメッセージ文字列とともにsend_notification()に渡す必要があります。 #ユーザーメールアドレスを使用してプッシュ通知を送信する push_notification_service = app.push_notification() user_list = ["amelia.burrows@gmail.com", "emma.hillary@gmail.com"] logging.info(push_notification_service.web().send_notification("Hi there! The task you scheduled has been completed.", user_list)) 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "モバイルアプリへの通知送信" description: "このページでは、Pythonアプリケーションからエンドユーザーにリモート通知を送信するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.358Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/push-notifications/send-notifications-mobile/" service: "Cloud Scale" related: - Push Notifications Help (/ja/cloud-scale/help/push-notifications/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # モバイルアプリへのプッシュ通知 Catalyst Cloud Scale Push Notificationsコンポーネントを使用すると、AndroidまたはiOSプラットフォームで構築されたモバイルアプリケーションに通知を送信できます。Catalyst User IDまたはメールアドレスを使用して、特定のターゲットユーザーにプッシュ通知を送信できます。ユーザーがアプリケーションに関与するためのアラート、アップデート、またはプロモーションコンテンツを含めることができます。 プッシュ通知を設定するには、以下の前提条件を満たす必要があります： 1. モバイルアプリケーションをCatalystに登録し、設定後にコンソールからアプリケーションID（appId）を控えておく必要があります。個別のプラットフォーム固有のCatalyst Mobile SDKメソッド（AndroidおよびiOSで利用可能）またはFlutter SDKを使用して、ターゲットデバイスにインストールされたアプリケーションを登録できます。 appIdは、Catalystコンソールで直接Android Push Notificationsサービスを設定することで取得できます。 Android SDKを使用したAndroidアプリの登録について学ぶ。 iOS SDKを使用したiOSアプリの登録について学ぶ。 Flutter SDKを使用したモバイルアプリ（AndroidまたはiOS）の登録について学ぶ。 2. モバイルアプリケーションは、Catalyst Serverless Authenticationコンポーネントを必ず使用する必要があります。 すべての設定が完了したら、Catalystユーザーが通知を迅速に受信するために、デバイスにログインしている必要があります。 設定が完了したら、生成されたアプリケーションIDを使用して特定のアプリをターゲットにし、以下のPython SDKメソッドを呼び出して通知を送信できます。 ### モバイル通知インスタンスの取得 モバイル通知インスタンスを作成し、Catalystコンソールに登録された特定のモバイルアプリを参照するために使用できます。これは、生成されたappIDをパラメータとして渡して、push_notification().mobile()メソッドでモバイル通知インスタンスを取得することで行います。 このモバイル通知インスタンスを使用して、次のセクションで説明するプッシュ通知の送信など、Python SDKメソッドで追加操作を実行します。 mobile_notification = app.push_notification().mobile("1234567890") ここで、1234567890はappIDです。あるいは、アプリケーションがCatalystスコープベースのアクセスを使用している場合は、appIDとともにZCProject projectパラメータを渡すことができます。 Catalyst SDKスコープの詳細を学ぶ。 mobile_notification = app.push_notification().mobile("1234567890", ZCProject project) #### Androidプッシュ通知の送信 プッシュ通知送信のためにAndroidアプリケーションを登録した後、send_android_notification()メソッドを使用してアプリケーションにプッシュ通知を送信できます。 send_android_notification()メソッドには2つのパラメータを渡す必要があります： * notify_obj - プッシュ通知メッセージの詳細を含むオブジェクトです。 * recipient - メッセージを配信する受信者のCatalyst User IDまたはメールアドレスです。 以下のコードスニペットを使用して、アプリケーションでsend_android_notification()メソッドを呼び出すことができます： mobile_notification.send_android_notification( notify_obj={"message": "This message is to test if the functionality is working fine!", "badge_count": 1}, recipient="emma.b@zylker.com" ) badge_countはアプリアイコンの通知バッジカウントを1に設定します。この値は必要に応じて任意の数値に変更できます。 #### iOSプッシュ通知の送信 Androidと同様に、プッシュ通知送信のためにiOSアプリケーションをCatalystに登録した後、send_ios_notification()メソッドを使用してアプリケーションにプッシュ通知を送信できます。 mobile_notification.send_ios_notification( notify_obj={"message": "test_notification", "badge_count": 1}, recipient="testuser@zylker.com" ) ##### 検索 -------------------------------------------------------------------------------- title: "検索インスタンスの取得" description: "このページでは、Pythonアプリケーションで複数のテーブルのデータを検索するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.358Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/search/get-component-instance/" service: "Cloud Scale" related: - Search Integration Help (/ja/cloud-scale/help/search-integration/introduction) -------------------------------------------------------------------------------- # Search Catalyst CloudScale Searchでは、特定のテーブルの検索インデックス付きカラムで特定のパターンを検索するプロセスを指定できます。複数のテーブルのインデックス付きカラムで検索することもできます。このセクションでは、アプリケーションでCatalyst検索機能を実装するために使用できるさまざまなSDKメソッドについて説明します。 ### コンポーネントインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに固有の事前定義された設定にアクセスするために使用できるオブジェクトです。この処理はサーバーサイドの呼び出しを発行しません。 以下のコードで使用されているapp参照は、SDK初期化時にレスポンスとして返されるPythonオブジェクトです。以下に示すように、新しいsearch_serviceインスタンスを作成できます。また、このコンポーネントインスタンスは、アプリケーションで検索コンポーネントを実装する際の複数のシナリオで使用されることに注意してください。 #Searchコンポーネントインスタンスを取得する search_service = app.search() -------------------------------------------------------------------------------- title: "データの検索" description: "このページでは、Pythonアプリケーションで複数のテーブルのデータを検索するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.358Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/search/search-data/" service: "Cloud Scale" related: - Search data - API (/ja/api/code-reference/cloud-scale/search/execute-search-query/#ExecuteSearchQuery) - Search Integration Help (/ja/cloud-scale/help/search-integration/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # データ検索 Catalyst Searchを使用すると、Catalyst Data Storeからデータレコードを検索して取得できます。execute_search_query()メソッドを使用して検索クエリを実行し、特定のデータパターンを検索できます。 ### 辞書の作成 以下のコードスニペットは、個々のData Storeテーブルのインデックス付きカラムで検索するパターンの属性を含む辞書を作成します。 #辞書を作成する config = { 'search': 'burrows*', 'search_table_columns': { 'Employee': ['EmployeeID'], 'Users': ['Name'] } } ### 検索クエリの実行 前のセクションで作成した辞書オブジェクトをexecute_search_query()メソッドのパラメータとして渡すと、レスポンスが返されます。以下で使用されているコンポーネントインスタンスsearch_serviceの詳細については、こちらのヘルプセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>config</td> <td>Object</td> <td>必須パラメータです。検索パターンの詳細を保持します。</td> </tr> </tbody> </table> #検索クエリを実行する search_service = app.search() response_data = search_service.execute_search_query(config) サンプルレスポンスを以下に示します： { AlienCity: [ { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-13 13:49:19:475", CITYNAME: "Dallas", CREATEDTIME: "2021-08-13 13:49:19:475", ROWID: "2136000000008508" } ] } 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 ##### 接続 -------------------------------------------------------------------------------- title: "接続インスタンスの取得" description: "このページでは、Connections SDKメソッドを使用するためのConnectionsコンポーネントのインスタンスを取得する方法について説明します。" last_updated: "2026-06-10T06:04:54.358Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/connections/get-connections-instance/" service: "Cloud Scale" related: - Connections Help (/ja/cloud-scale/help/connections/introduction/) - Connections Java SDK (/ja/sdk/java/v1/cloud-scale/connections/get-connections-instance/) - Connections Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/connections/get-connections-instance/) -------------------------------------------------------------------------------- # Connections Connectionsを使用すると、すべての認証トークン要件を管理しながら、Zohoおよびその他のサードパーティサービスと統合できます。 ### 接続インスタンスの取得 注意： このSDKは、FunctionsやAppSailなどのCatalystサービス内でのみアクセスできます。サードパーティサービスとの統合には使用できません。 以下のようにconnectionsコンポーネントの参照を取得できます。これはサーバーサイドの呼び出しを発生させません。このコンポーネントインスタンスは、Connectionsを使用する各種コードスニペットで参照します。 # コネクションインスタンスを作成する connections = app.connections() -------------------------------------------------------------------------------- title: "認証資格情報の取得" description: "このページでは、Connections SDKメソッドを使用するためのConnectionsコンポーネントのインスタンスを取得する方法について説明します。" last_updated: "2026-06-10T06:04:54.358Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/connections/get-credentials/" service: "Cloud Scale" related: - Connections Help (/ja/cloud-scale/help/connections/introduction/) - Connections Java SDK (/ja/sdk/java/v1/cloud-scale/connections/get-credentials/) - Connections Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/connections/get-credentials/) -------------------------------------------------------------------------------- # 認証資格情報の取得 注意： このSDKは、FunctionsやAppSailなどのCatalystサービス内でのみアクセスできます。サードパーティサービスとの統合には使用できません。 このSDKメソッドを使用して、デフォルトサービスとして一覧表示されているさまざまなZohoサービスの認証資格情報を取得できます。 以下のコードスニペットで使用されているconnectionsの参照は、コンポーネントインスタンスです。 # コネクションインスタンスを作成する connections = app.connections() #指定されたコネクションの認証資格情報を取得する connection_response = connections.get_connection_credentials('payrollcon') #コネクションレスポンス print('connection response:', connection_response) ##### 認証 -------------------------------------------------------------------------------- title: "認証インスタンスの取得" description: "このページでは、Pythonアプリケーションでコンポーネントインスタンスを作成する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.359Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/authentication/get-component-instance/" service: "Cloud Scale" related: - Authentication Help (/ja/cloud-scale/help/authentication/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # 認証 Python SDKのCatalyst Cloud Scale認証機能を使用すると、新しいユーザーの追加、現在のユーザーまたは全ユーザーの詳細取得、既存のユーザーアカウントのパスワードリセット、ユーザーの削除など、ユーザー認証に関する操作を実行できます。 ### コンポーネントインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに関する定義済みの設定にアクセスするために使用できるオブジェクトです。認証のコンポーネントインスタンスを作成して、さまざまなユーザー管理アクションを実行できます。これはサーバーサイドの呼び出しを発生させません。 以下のコードで使用されているappの参照は、SDK初期化時にレスポンスとして返されるPythonオブジェクトです。以下のように新しいauthentication_serviceインスタンスを作成できます： #Authenticationコンポーネントインスタンスを取得する authentication_service = app.authentication() このコンポーネントインスタンスは、Python SDKドキュメントの各認証セクションで示されているように使用します。 -------------------------------------------------------------------------------- title: "新規ユーザーの追加" description: "このページでは、Pythonアプリケーションに新しいエンドユーザーを追加する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.359Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/authentication/add-new-user/" service: "Cloud Scale" related: - Add New User - API (/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser) - Authentication Help (/ja/cloud-scale/help/authentication/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # 新規ユーザーの追加 Catalystアプリケーションにエンドユーザーを追加できます。組織が明示的に指定されていない場合、ユーザーはデフォルトの組織に自動的に割り当てられます。ユーザーが追加されると、Catalystによって一意のuser_IDとZUIDが生成されます。 #### ディクショナリの作成 Catalystアプリケーションに新しいユーザーを追加する前に、ユーザーの姓、割り当てるロール、メールアドレス、アプリケーションプラットフォーム、現在の作業環境に基づくZAIDデータなどのユーザー詳細を含むディクショナリを作成する必要があります。これらの詳細を含むディクショナリは、register_user()メソッドにパラメータとして渡されます。 注意： * ユーザーを登録するには、email_idとfirst_nameの値を必ず指定する必要があります。 * role_idは、Catalystコンソールの_Authentication_の_Roles_セクションから取得できます。 * ZAIDは、Catalystコンソールの環境設定から取得できます。 * 新しいユーザーを招待する際に、送信者のメールアドレス、件名、メールメッセージを設定できます。SDKコードで使用する前に、Catalyst Mailコンポーネントでメールアドレスを追加し、認証を完了させる必要があります。 #辞書を作成する signup_config = { "platform_type": "web", "zaid": "81008807534807534", "template_details": { "senders_mail": "dogogetu@tutuapp.bid", "subject": "Welcome to %APP_NAME%", "message": "&lt;p&gt;Hello ,&lt;/p&gt; &lt;p&gt;Follow this link to join in %APP_NAME% .&lt;/p&gt; &lt;p&gt;&lt;a href='%LINK%'&gt;%LINK%&lt;/a&gt;&lt;/p&gt; &lt;p&gt;If you didn't ask to join the application, you can ignore this email.&lt;/p&gt; &lt;p&gt;Thanks,&lt;/p&gt; &lt;p&gt;Your %APP_NAME% team&lt;/p&gt;", }, } user_details = { "first_name": "Amelia", "last_name": "Burrows", "role_id": "1008807534", "email_id": "amelia.burrows@zylker.com", } ### 新規ユーザーの追加 ディクショナリに必要なユーザー情報を設定した後、組織に新しいユーザーを追加できます。この場合、組織はユーザーに自動的に割り当てられます。 register_user()メソッドはユーザー作成プロセスを処理し、レスポンスを返します。以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。 注意： 開発環境では、アプリケーションに追加できるユーザーは25人までです。アプリケーションを本番環境にデプロイした後は、任意の数のエンドユーザーを追加できます。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>signup_config</td> <td>Object</td> <td>必須パラメータです。アプリケーションプラットフォーム、ZAID、登録後に送信するメール情報を含むユーザー登録の詳細を格納します。</td> </tr> <tr> <td>user_details</td> <td>Object</td> <td>必須パラメータです。名、姓、メールID、ユーザーを追加する組織のIDなどのユーザー登録詳細を保持します。</td> </tr> </tbody> </table> #新しいユーザーを追加する authentication_service = app.authentication() response_data = authentication_service.register_user(signup_config, user_details) サンプルレスポンスを以下に示します： { "zaid":"81008807534807534", "user_details":{ "zuid":"1005641290", "org_id":"1005641456", "status":"ACTIVE", "is_confirmed":false, "email_id":"amelia.burrows@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "created_time":"Aug 12, 2021 12:33 PM", "modified_time":"Aug 12, 2021 12:33 PM", "invited_time":"Aug 12, 2021 12:33 PM", "role_details":{ "role_name":"App User", "role_id":"2305000000006024" }, "user_type":"App User", "user_id":"2305000000007752", "project_profiles":[ ] }, "redirect_url":"https://aliencity-66446133.development.catalystserverless.com/app/", "platform_type":"web", "org_id":"1005641456" } 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "既存組織への新規ユーザーの追加" description: "このページでは、Pythonアプリケーションで既存の組織に新しいユーザーを追加する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.359Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/authentication/add-new-user-to-existing-org/" service: "Cloud Scale" related: - Add New User to Existing Org - API (/ja/api/code-reference/cloud-scale/authentication/add-user-to-existing-org/#AddaNewUsertoanExistingOrganization) - Authentication Help (/ja/cloud-scale/help/authentication/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # 既存の組織への新規ユーザーの追加 新しい組織を作成せずに、既存の組織にエンドユーザーを追加できます。これは、ユーザーを追加する組織の**OrgID**を指定することで実行できます。 ユーザーがサインアップすると、CatalystによってZUIDとUser IDなどの一意の識別値が作成されます。 注意： * 既存の組織にユーザーを追加するには、org_id、email_id、 last_nameの値を必ず指定する必要があります。 * ZAIDは、Catalystコンソールの環境設定から取得できます。 * role_idを指定してロールに追加することもできます。これはCatalystコンソールのAuthenticationのRolesセクションから取得できます。 * 新しいユーザーを招待する際に、送信者のメールアドレス、件名、メールメッセージを設定できます。SDKコードで使用する前に、Catalyst Mailコンポーネントでメールアドレスを追加し、認証を完了させる必要があります。 ## ディクショナリの作成 Catalystアプリケーションに新しいエンドユーザーを追加する前に、以下のように特定のユーザーの登録詳細を含むディクショナリを作成する必要があります。その後、設定したディクショナリをユーザーサインアッププロセスを処理するメソッドに渡すことができます。 #辞書を作成する signup_config = { "platform_type": "web", "zaid": "1008807534", "template_details": { "senders_mail": "dogogetu@tutuapp.bid", "subject": "Welcome to %APP_NAME%", "message": "&lt;p&gt;Hello ,&lt;/p&gt; &lt;p&gt;Follow this link to join in %APP_NAME% .&lt;/p&gt; &lt;p&gt;&lt;a href='%LINK%'&gt;%LINK%&lt;/a&gt;&lt;/p&gt; &lt;p&gt;If you didn't ask to join the application, you can ignore this email.&lt;/p&gt; &lt;p&gt;Thanks,&lt;/p&gt; &lt;p&gt;Your %APP_NAME% team&lt;/p&gt;", }, } user_details = { "first_name": "Amelia", "last_name": "Burrows", "email_id": "amelia.burrows@gmail.com", "org_id": "1005641456", } ### 既存組織への新規ユーザーの追加 以下のコードを使用して、既存の組織に新しいエンドユーザーを追加できます。前のセクションで作成したディクショナリをadd_user_to_org()メソッドの引数として渡す必要があります。このメソッドはユーザーサインアッププロセスを処理し、レスポンスを返します。 注意： 開発環境では、アプリケーションに追加できるユーザーは25人までです。アプリケーションを本番環境にデプロイした後は、任意の数のエンドユーザーを追加できます。 以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>signup_config</td> <td>Object</td> <td>必須パラメータです。アプリケーションプラットフォーム、ZAID、登録後に送信するメール情報を含むユーザー登録の詳細を格納します。</td> </tr> <tr> <td>user_details</td> <td>Object</td> <td>必須パラメータです。名、姓、メールID、ユーザーを登録する組織のIDなどのユーザー登録詳細を保持します。</td> </tr> </tbody> </table> #既存の組織に新しいユーザーを追加する authentication_service = app.authentication() response_data = authentication_service.add_user_to_org(signup_config, user_details) サンプルレスポンスを以下に示します： { "zaid":"1008807534", "user_details":{ "zuid":"1005643749", "org_id":"1005641456", "status":"ACTIVE", "is_confirmed":false, "email_id":"amelia.burrows@gmail.com", "first_name":"Amelia", "last_name":"Burrows", "created_time":"Aug 12, 2021 03:56 PM", "modified_time":"Aug 12, 2021 03:56 PM", "invited_time":"Aug 12, 2021 03:56 PM", "role_details":{ "role_name":"App User", "role_id":"2305000000006024" }, "user_type":"App User", "user_id":"2305000000009002", "project_profiles":[ ] }, "redirect_url":"https://aliencity-66446133.development.catalystserverless.com/app/", "platform_type":"web", "org_id":"1005641456" } 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "パスワードのリセット" description: "このページでは、Pythonアプリケーションでユーザーアカウントのパスワードをリセットする方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.359Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/authentication/reset-password/" service: "Cloud Scale" related: - Reset Password - API (/ja/api/code-reference/cloud-scale/authentication/reset-user-password/#ResetUserPassword) - Authentication Help (/ja/cloud-scale/help/authentication/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # パスワードのリセット 以下のコードスニペットを使用して、登録済みユーザーのアカウントのパスワードをリセットできます。reset_password()メソッドを呼び出すと、パスワードリセットリンクが生成され、ユーザーのメールアドレスに送信されます。 注意： * email_id、platform_type、およびzaidは必須属性です。 * 送信者のメールアドレス、件名、メールメッセージを設定できます。SDKコードで使用する前に、Catalyst Mailコンポーネントでメールアドレスを追加し、認証を完了させる必要があります。 #### ディクショナリの作成 以下のように、特定のユーザーの登録詳細を含むディクショナリを作成する必要があります。その後、設定したディクショナリをパスワードリセットプロセスを処理するメソッドに渡すことができます。 #辞書を作成する reset_config = { "platform_type": "web", "zaid": "1008807534", "template_details": { "senders_mail": "dogogetu@tutuapp.bid", "subject": "Welcome to %APP_NAME%", "message": "<p>Hello ,</p> <p>Follow this link to join in %APP_NAME% .</p> <p><a href='%LINK%'>%LINK%</a></p><p>If you didnt ask to join the application, you can ignore this email.</p><p>Thanks,</p> <p>Your %APP_NAME% team</p>", }, } ### パスワードのリセット ユーザー情報とユーザーサインアップ設定を含むオブジェクトをreset_password()メソッドの引数として渡し、レスポンスが返されます。 以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>email_id</td> <td>String</td> <td>必須パラメータです。ユーザーのメールアドレスの値を保持します。</td> </tr> <tr> <td>reset_config</td> <td>Object</td> <td>必須パラメータです。パスワードをリセットするユーザーアカウントの詳細を格納します。これらの詳細には、アプリケーションプラットフォームタイプ、ZAID、パスワードリセット後に送信するメール情報が含まれます。</td> </tr> </tbody> </table> user = app.user_management() users = user.reset_password('amelia.b@zylker.com', { 'platform_type': 'web', 'redirect_url': 'https://www.google.com', 'template_details': { 'subject': 'Reset Password', 'message': 'Click on the link to reset your password: <a href="{{reset_password_url}}">Reset Password</a>', 'senders_mail': 'support@zylker.com' } }) print(users) サンプルレスポンスを以下に示します： "Reset link sent to amelia.burrows@zylker.com. Please check your email". 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "カスタムユーザー検証" description: "このページでは、Pythonアプリケーションでユーザーアカウントのパスワードをリセットする方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.359Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/authentication/custom-user-validation/" service: "Cloud Scale" related: - Authentication Help (/ja/cloud-scale/help/authentication/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # カスタムユーザー検証 Catalyst認証では、Catalystアプリケーションへのサインアップ時に、カスタムBasic I/O関数を使用してエンドユーザーを認可および検証できます。この関数を通じてユーザーが提供する資格情報を処理する独自のロジックを記述し、アプリケーションへのアクセスを許可できます。 以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。 Custom User Validation関数のサンプルコードを以下に示します。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>basicio</td> <td>Function</td> <td>必須パラメータです。エンドユーザーの認可と検証を可能にするBasic IO Catalyst関数です。</td> </tr> </tbody> </table> import json import zcatalyst_sdk def handler(context, basicio): app = zcatalyst_sdk.initialize() authentication_service = app.authentication() request_details = authentication_service.get_signup_validation_request(basicio) if request_details: print("response :", request_details) if "spam.com" in request_details["user_details"]["email_id"]: basicio.write(json.dumps({"status": "failure"})) else: basicio.write( json.dumps( { "status": "success", "user_details": { "first_name": "Amelia", "last_name": "Jack", "role_identifier": "cx_role", "org_id": 1012535411 # Org IDを指定する場合は、コンソールからコピーする必要があります。 }, } ) ) context.close() この関数をテストするには、以下の.JSON形式でユーザーの詳細を渡すことができます： { "request_type":"add_user", "request_details":{ "user_details":{ "email_id":"emmy@zylker.com", "first_name":"Emma", "last_name":"Thompson", "org_id":"432567817", "role_details":{ "role_name":"Moderator", "role_id":"879" } }, "auth_type":"web" } } 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "カスタムサーバートークンの生成" description: "このページでは、Pythonアプリケーションでユーザーアカウントのパスワードをリセットする方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.359Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/authentication/third-party-server-token/" service: "Cloud Scale" related: - Authentication Help (/ja/cloud-scale/help/authentication/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # カスタムサーバートークンの生成 Cloud ScaleのAuthenticationコンポーネントでは、Catalystアプリケーションに任意のサードパーティ認証サービスを実装できます。エンドユーザーの認可と検証はサードパーティサービスによって処理され、データはCatalystに渡されます。 注意： * サードパーティ認証サービスを実装しているため、アプリケーションのセキュリティインフラストラクチャは、選択したサードパーティサービスの効率性に依存します。 * Catalystアプリケーションでサードパーティ認証を有効にするには、コンソールでPublic Signupを有効にしていることを確認する必要があります。 ユーザーが認証後にサードパーティサービスからリダイレクトされると、そのユーザーの資格情報を、コーディングした認証関数に渡す必要があります。この関数には、カスタムサーバートークンを生成するためのCatalystサーバーサイドスクリプトを含める必要があり、生成されたトークンはクライアントコードに組み込まれたWeb SDKに渡されます。 情報： 以下の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">String</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>type</td> <td>String</td> <td>必須パラメータです。アプリケーションタイプの値を保持します。</td> </tr> <tr> <td>user_details</td> <td>Object</td> <td>必須パラメータです。エンドユーザーのfirst_nameとemail_idの値を保持します。</td> </tr> </tbody> </table> import zcatalyst_sdk def handler(context, basicio): app = zcatalyst_sdk.initialize() auth = app.authentication() resp = auth.generate_custom_token( { "type": "web", "user_details": { "first_name": "Amelia", "email_id": "amelia.burrows@zylker.com", }, } ) basicio.write(str(resp)) context.close() このトークンを、このWeb SDKヘルプページで説明されているようにクライアントロジックに渡すことができます。 注意： カスタムサーバートークンは、ユーザーがサードパーティ認証サービスを使用してアプリケーションにログインするたびに生成する必要があります。 -------------------------------------------------------------------------------- title: "ユーザー詳細の更新" description: "このページでは、Pythonアプリケーションでユーザーアカウントのパスワードをリセットする方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.359Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/authentication/update-user-details/" service: "Cloud Scale" related: - Authentication Help (/ja/cloud-scale/help/authentication/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # ユーザー詳細の更新 Catalystでは、エンドユーザーの以下の詳細を変更および更新できます： * 名 * 姓 * OrgID：OrgIDは、組織に関連付けるためにCatalystによって生成される一意の値です。 * RoleID：Role IDは、特定のユーザーロールに割り当てられる、Catalystによって生成される値です。 ### ディクショナリの作成 update_config = { "email_id": "amelia.burrows@zylker.com", "last_name": "Burrows", "first_name": "Amelia", "org_id": "1012585680", "role_id": "6759000000054065", } 以下のSDKスニペットは、update_user_details(userID, userDetails)メソッドを使用してエンドユーザーの詳細を更新する方法を示しています。以下の例では、ユーザーの名が更新されます。 以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>UserID</td> <td>String</td> <td>必須パラメータです。詳細を更新するユーザーのUserIDを保持します。</td> </tr> <tr> <td>update_config </td> <td>Object</td> <td>必須パラメータです。email_id、last_name、first_name、org_id、role_idの値を保持します。ここでfirst_nameまたはlast_nameパラメータを更新できます。</td> </tr> </tbody> </table> authentication_service = app.authentication() user_details=authentication_service.update_user_details('6759000000124659', update_config) 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "ユーザー詳細の取得" description: "このページでは、PythonアプリケーションでData Storeからユーザー詳細を取得する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.359Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/authentication/get-user-details/" service: "Cloud Scale" related: - Get User Details - API (/ja/api/code-reference/cloud-scale/authentication/get-current-user/#GetCurrentUser) - Authentication Help (/ja/cloud-scale/help/authentication/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # ユーザー詳細の取得 Catalyst認証は、アプリケーションユーザーの詳細を取得するためのいくつかのメソッドを提供しています。現在のユーザー、特定のユーザー、またはアプリケーションの全ユーザーのユーザー情報を取得できます。 ### 現在のユーザーの詳細を取得 get_current_user()メソッドは、アプリケーションにアクセスしている現在のユーザー、つまり関数が実行されているスコープのユーザーの詳細を取得します。以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。 #ユーザーの詳細を取得する authentication_service = app.authentication() current_user = authentication_service.get_current_user() サンプルレスポンスを以下に示します： { "zuid":"1005641433", "org_id":"1005641434", "status":"ACTIVE", "is_confirmed":false, "email_id":"amelia.burrows@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "created_time":"Aug 12, 2021 12:27 PM", "role_details":{ "role_name":"App User", "role_id":"2305000000006024" }, "user_type":"App User", "user_id":"2305000000007745", "locale":"us|en|Asia/Kolkata", "time_zone":"Asia/Kolkata", "project_profiles":[ ] } ### User IDによるユーザー詳細の取得 get_user_details()メソッドにユーザーのuserIDを渡すことで、特定のユーザーの詳細を取得できます。レスポンスには、姓、ユーザーが持つロールのリスト、ユーザータイプ、ユーザーが所属する組織のorgID、メールアドレスなど、特定のユーザーの詳細が返されます。 以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>user_id</td> <td>String</td> <td>必須パラメータです。詳細を取得するユーザーの一意のIDを格納します。</td> </tr> </tbody> </table> #ユーザーIDで詳細を取得する authentication_service = app.authentication() user_details=authentication_service.get_user_details('12345') サンプルレスポンスを以下に示します： { "zuid":"1005665160", "org_id":"1005665245", "status":"ACTIVE", "is_confirmed":false, "email_id":"mikerogers@zylker.com ", "first_name":"Michael", "last_name":"Rogers", "created_time":"Aug 17, 2021 04:55 PM", "role_details":{ "role_name":"App User", "role_id":"2136000000007748" }, "user_type":"App User", "user_id":"2136000000020040", "locale":"us|en|Asia/Kolkata", "time_zone":"Asia/Kolkata", "project_profiles":[ ] } ### 全ユーザーの詳細を取得 get_all_users()メソッドは、すべての組織の全ユーザーの詳細を取得できます。 レスポンスには、すべてのユーザーの姓、ロールのリスト、ユーザータイプ、メールアドレス、userID、zuid、タイムゾーンなどの詳細が返されます。 以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。 #すべてのユーザーの詳細を取得する authentication_service = app.authentication() user_details = authentication_service.get_all_users() サンプルレスポンスを以下に示します： [ { "zuid":"1005648252", "org_id":"1005648253", "status":"ACTIVE", "is_confirmed":false, "email_id":"p.boyle@zylker.com", "first_name":"Parker", "last_name":"Boyle", "created_time":"Aug 13, 2021 01:36 PM", "modified_time":"Aug 13, 2021 01:36 PM", "invited_time":"Aug 13, 2021 01:36 PM", "role_details":{ "role_name":"App User", "role_id":"2136000000007748" }, "user_type":"App User", "user_id":"2136000000007774", "locale":"us|en|Asia/Kolkata", "time_zone":"Asia/Kolkata", "project_profiles":[ ] }, { "zuid":"1005665160", "org_id":"1005665245", "status":"ACTIVE", "is_confirmed":false, "email_id":"rsmith@zylker.com ", "first_name":"Robert", "last_name":"Smith", "created_time":"Aug 17, 2021 04:55 PM", "modified_time":"Aug 17, 2021 04:55 PM", "invited_time":"Aug 17, 2021 04:55 PM", "role_details":{ "role_name":"App User", "role_id":"2136000000007748" }, "user_type":"App User", "user_id":"2136000000020040", "locale":"us|en|Asia/Kolkata", "time_zone":"Asia/Kolkata", "project_profiles":[ ] } ] ### 組織内の全ユーザーの詳細を取得 特定の組織に属するユーザーを取得するには、org_idをget_all_users()メソッドにパラメータとして渡します。 以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>org_id</td> <td>String</td> <td>任意パラメータです。ユーザー詳細を取得する組織のIDを格納します。`org_id`が指定されない場合、すべての組織のすべてのユーザーの詳細が取得されます。</td> </tr> </tbody> </table> #すべてのユーザーの詳細を取得する authentication_service = app.authentication() user_details = authentication_service.get_all_users(1293028) サンプルレスポンスを以下に示します： [ { "zuid":"1005648252", "org_id":"1005648253", "status":"ACTIVE", "is_confirmed":false, "email_id":"roger.p@zylker.com", "first_name":"Roger", "last_name":"Parkinson", "created_time":"Aug 13, 2021 01:36 PM", "modified_time":"Aug 13, 2021 01:36 PM", "invited_time":"Aug 13, 2021 01:36 PM", "role_details":{ "role_name":"App User", "role_id":"2136000000007748" }, "user_type":"App User", "user_id":"2136000000007774", "locale":"us|en|Asia/Kolkata", "time_zone":"Asia/Kolkata", "project_profiles":[ ] } ] 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "ユーザーの削除" description: "このページでは、Pythonアプリケーションからユーザーを削除する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.360Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/authentication/delete-user/" service: "Cloud Scale" related: - Authentication Help (/ja/cloud-scale/help/authentication/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # ユーザーの削除 Catalystアプリケーションのエンドユーザーを削除して、アプリケーションへのアクセスを停止させることができます。これは、delete_user()メソッドを呼び出し、削除するユーザーのUserIDをパラメータとして渡すことで実行できます。このメソッドは、ユーザーが削除されるとtrueをレスポンスとして返します。 以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>UserID</td> <td>String</td> <td>必須パラメータです。削除するユーザーのIDを格納します。</td> </tr> </tbody> </table> #既存のユーザーを削除する authentication_service = app.authentication() delete_response = authentication_service.delete_user(2305000000007745) 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "ユーザーの有効化または無効化" description: "このページでは、Pythonアプリケーションでユーザーを有効化または無効化する方法について、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.360Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/cloud-scale/authentication/enable-disable-user/" service: "Cloud Scale" related: - Authentication Help (/ja/cloud-scale/help/authentication/introduction) - Enable or Disable a User in the Console (/ja/cloud-scale/help/authentication/user-management/users/implementation/#enable-or-disable-a-user) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # ユーザーの有効化または無効化 Catalystでは、いつでもユーザーを無効化または有効化できます。無効化されたユーザーはアプリケーションにサインアップされたままですが、アプリケーションにアクセスすることはできません。 以下のSDKスニペットは、update_user_status(userId, user_status)メソッドを使用してエンドユーザーを有効化および無効化する方法を示しています。 ユーザーは一意のUser IDで参照されます。すべてのユーザーのUser IDは、Authenticationコンポーネントの*Users* > *User Management*セクションに移動して確認できます。 以下で使用されているコンポーネントインスタンスauthentication_serviceの詳細については、こちらのセクションを参照してください。 ### ユーザーの有効化 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>userId</td> <td>String</td> <td>必須パラメータです。アプリケーションで有効化するユーザーのUserIDを保持します。</td> </tr> <tr> <td>user_status</td> <td>String</td> <td>必須パラメータです。デフォルト値"enable"を保持します。</td> </tr> </tbody> </table> authentication_service = app.authentication() user_details = authentication_service.update_user_status('6759000000124659', 'enable') # ユーザーIDを置き換える ### ユーザーの無効化 **使用するパラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>userId</td> <td>String</td> <td>必須パラメータです。アプリケーションで無効化するユーザーのUserIDを保持します。</td> </tr> <tr> <td>user_status</td> <td>String</td> <td>必須パラメータです。デフォルト値"disable"を保持します。</td> </tr> </tbody> </table> authentication_service = app.authentication() user_details = authentication_service.update_user_status('6759000000124659', 'disable') # ユーザーIDを置き換える 情報： 上記の操作を実行するために必要な権限レベルについては、SDKスコープの表を参照してください。 #### Connectors -------------------------------------------------------------------------------- title: "コネクタ" description: "このページでは、サンプルコードスニペットを使用して、Pythonアプリケーションでコネクターを使用してアクセストークンを管理する方法について説明します。" last_updated: "2026-06-10T06:04:54.360Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/connectors/connectors/" service: "All Services" related: - Cache Help (/ja/cloud-scale/help/cache/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Connectors Catalyst Connectorは、**Zoho OAuth認証**を通じて確立される、Catalystと外部Zohoサービス間のシームレスな接続を提供します。ビジネスロジックにZoho CRMやZoho WorkDrive APIなどの外部ZohoサービスのAPIの使用が含まれている場合、Catalystアプリケーションでコネクターを利用できます。 Catalystは、Zoho APIコンソールで特定のアプリケーション向けに生成したアクセストークンを、有効期限が切れるまでCatalyst Cacheに保存して接続を管理します。有効期限が切れると、コネクターはリフレッシュトークンを使用して新しいアクセストークンを自動的に取得し、キャッシュに保存します。アクセストークンの有効期限が切れるたびに、コネクターがバックグラウンドで自動的に新しいトークンを取得してキャッシュするため、アプリケーションのビジネスロジック内で外部Zohoサービスとの中断のない接続を維持するロジックを構築する手間が省けます。 注意: Catalyst Connectorは、外部Zohoサービスとの接続を維持するためにのみ使用でき、サードパーティサービスには使用できません。これは、すべてのZohoサービスで維持されているOAuth標準が統一されており、CatalystがConnectors機能を実装するために互換性があるためです。 以下に示すようにPythonビジネスロジックでコネクターを設定する前に、Zoho APIコンソールで新しいクライアントを登録し、初回の認証コードとアクセストークンを生成する手順に従う必要があります。その後、受け取ったリフレッシュトークンと、Client ID、Client Secret、認証URL、リフレッシュURLなど、アクセストークンを定期的に自動更新するために必要な標準的なOAuthパラメータを使用してコネクターを設定できます。 注意: * ロジック内の各コネクターに指定する名前は一意である必要があります。 * Zoho APIコンソールでサーバーベースのアプリケーションを作成し、同じアプリケーション内の異なるユーザーに対してアクセストークンの作成を許可する場合、各ユーザーに対して異なる一意のコネクター名を指定する必要があります。これは、同じコネクターがアプリケーション内の異なるユーザーに使用された場合、トークンが同じキャッシュセグメントに上書きされ、外部Zohoサービスから誤ったユーザーのデータが取得される結果となるためです。 以下のコードはPythonコネクターを示しています。以下で使用されているapp参照は、SDKの初期化時にレスポンスとして返されるPythonオブジェクトです。レスポンスはアクセストークンを返します： **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>ConnectorName</td> <td>Array</td> <td>必須パラメータです。client_id、client_secret、auth_url、refresh_url、refresh_tokenなどのコネクターの詳細を保存します。</td> </tr> </tbody> </table> connector = app.connection( { "ConnectorName": { "client_id": {add_client_id}, "client_secret": {add_client_secret}, "auth_url": {add_auth_url}, "refresh_url": {add_refresh_url}, "refresh_token": {add_refresh_token}, "refresh_in": {add_refresh_in} # アプリ登録後にZoho APIコンソールで認可コードを生成して返された値からOAuthパラメータを設定する } } ).get_connector("{ConnectorName}") #作成するコネクタごとに一意のコネクタ名を指定する access_token = connector.get_access_token() 情報 : 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 #### Job Scheduling -------------------------------------------------------------------------------- title: "概要" description: "このページでは、Job Scheduling操作を実行するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.360Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/overview/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/overview/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/overview/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # Job Scheduling SDK Job Schedulingは、ジョブの送信をスケジュールし、ジョブプールで実行して、Circuits、Webhook（任意のサードパーティURL）、Job Functions、およびAppSailサービスのエンドポイントをトリガーできるCatalystサービスです。 Catalyst SDKを使用して、コードを通じて以下の操作を実行できます： <table class="content-table"> <thead> <tr> <th class="w25p">Job Schedulingコンポーネント</th> <th class="w75p">SDKを使用して可能な操作</th> </tr> </thead> <tbody> <tr> <td>ジョブプール</td> <td>すべてのジョブプールの取得<br />特定のジョブプールの取得</td> </tr> <tr> <td>ジョブ</td> <td>ジョブの作成<br />ジョブの詳細取得<br />ジョブの削除</td> </tr> <tr> <td>Cron</td> <td>ワンタイムCronの作成<br />定期Cronの作成<br />Cron式を使用したCronの作成<br />特定のCronの詳細取得<br />すべてのCronの詳細取得<br />Cronの更新<br />Cronの一時停止<br />Cronの再開<br />Cronの実行<br />Cronの削除</td> </tr> </tbody> </table> <br /> -------------------------------------------------------------------------------- title: "Job Schedulingインスタンスの初期化" description: "このページでは、Job Schedulingサービスのコンポーネントリファレンスを作成する方法を説明します。" last_updated: "2026-06-10T06:04:54.360Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/initialize-job-scheduling-instance/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/initialize-job-scheduling-instance/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/initialize-job-scheduling-instance/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # Job Schedulingインスタンスの初期化 以下に示すように、Job Schedulingコンポーネントリファレンスを作成できます。これはサーバーサイドの呼び出しを実行しません。Job Schedulingのコンポーネントを操作するさまざまなコードスニペットで、このコンポーネントインスタンスを参照します。 job_scheduling = app.job_scheduling() # ジョブスケジューリングインスタンスを取得する ##### Cron -------------------------------------------------------------------------------- title: "ワンタイムCronの作成" description: "このページでは、プロジェクト内でワンタイムCronを作成するPythonメソッドをサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.360Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/cron/create-one-time-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/key-concepts/#schedule-type) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/create-one-time-cron/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/create-one-time-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/create-cron/create-one-time-cron/#CreateaOne-TimeCron) -------------------------------------------------------------------------------- # ワンタイムCronの作成 Cronコンポーネントは、ジョブのジョブプールへの送信をスケジュールするために使用されます。以下のSDKを使用すると、ジョブの送信を1回だけスケジュールするCronを作成できます。 注意: 以下のSDKは、Job Functionをトリガーするジョブ用に記述されています。SDKを他のタイプと互換性を持たせるには、適切なジョブプールID、またはジョブプール名に値を置き換え、適切なターゲット名、またはターゲットIDを指定する必要があります。 # Functionジョブメタデータを作成する job_meta = { "job_name": "test_job", # ジョブの名前を設定する "target_type": "Function", # 関数ジョブのターゲットタイプをFunctionに設定する "target_name": "target_function", # ターゲット関数の名前を設定する（オプション）（target_idまたはtarget_nameは必須） # 'target_id': '123467890', # ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須） "jobpool_name": "test", # 関数ジョブプールの名前を設定する（オプション）（jobpool_nameまたはjobpool_idは必須） # 'jobpool_id': '1234567890' # 関数ジョブプールのIDを設定する（オプション）（jobpool_nameまたはjobpool_idは必須） "job_config": { "number_of_retries": 2, # リトライ回数を設定する "retry_interval": 15 * 60, # リトライ間隔を設定する }, # ジョブ設定 - リトライ => 15分で2回リトライ（オプション） "params": { "arg1": "test", "arg2": "job", }, # ターゲット関数に渡すパラメータを設定する（オプション） } # ワンタイムCronを作成する one_time_cron = job_scheduling.CRON.create( { "cron_name": "one_time", # Cronの名前を設定する（一意） "description": "one_time_cron", # Cronの説明を設定する（オプション） "cron_status": True, # Cronのステータスを有効に設定する "cron_type": "OneTime", # CronタイプをOneTimeに設定する "cron_detail": { "time_of_execution": int(time.time()) + (60 * 10 * 1000), # 実行時間をUNIXタイムスタンプとして設定する # 'timezone': 'America/Los_Angeles' # タイムゾーンを設定する（オプション） }, "job_meta": job_meta, # Functionジョブメタデータを設定する } ) 注意: このSDKはダイナミックCronの構成にのみ使用することをお勧めします。事前定義Cronの構成にはUIビルダーを使用してください。 -------------------------------------------------------------------------------- title: "定期Cronの作成" description: "このページでは、プロジェクト内で定期Cronを作成するPythonメソッドをサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.361Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/cron/create-recurring-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/key-concepts/#schedule-type) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/create-recurring-cron/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/create-recurring-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/create-cron/create-every-cron/#CreateanEveryCron) -------------------------------------------------------------------------------- # 定期Cronの作成 以下のSDKを使用すると、さまざまな時間間隔で実行できる定期Cronを作成できます。間隔は分単位からカレンダー年単位まで設定できます。 ### Every Cronの作成 以下のSDKを使用して、**24時間未満**のスケジュールされた間隔でジョブプールにジョブを送信する定期Cronを作成できます。 注意: 以下のSDKは、2時間1分3秒ごとにジョブを送信するように構成されています。cron_detail JSONキーバリューペアに関連する値を渡すことで、要件に応じてこの値を変更できます。 # Functionジョブメタデータを作成する job_meta = { 'job_name': 'test_job', # ジョブの名前を設定する 'target_type': 'Function', # 関数ジョブのターゲットタイプをFunctionに設定する 'target_name': 'target_function', # ターゲット関数の名前を設定する（オプション）（target_idまたはtarget_nameは必須） # 'target_id': '123467890', # ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須） 'jobpool_name': 'test', # 関数ジョブプールの名前を設定する（オプション）（jobpool_nameまたはjobpool_idは必須） # 'jobpool_id': '1234567890' # 関数ジョブプールのIDを設定する（オプション）（jobpool_nameまたはjobpool_idは必須） 'job_config': { 'number_of_retries': 2, # リトライ回数を設定する 'retry_interval': 15 * 60 # リトライ間隔を設定する }, # ジョブ設定 - リトライ => 15分で2回リトライ（オプション） 'params': { 'arg1': 'test', 'arg2': 'job' } # ターゲット関数に渡すパラメータを設定する（オプション） } # Every Cronを作成する every_cron = job_scheduling.CRON.create({ 'cron_name': 'every_cron', # Cronの名前を設定する（一意） 'description': 'every_cron', # Cronの説明を設定する（オプション） 'cron_status': True, # Cronのステータスを有効に設定する 'cron_type': 'Periodic', # Every Cron用のCronタイプをPeriodicに設定する 'cron_detail': { 'hour': 2, # 繰り返しの時間間隔を設定する 'minute': 1, # 繰り返しの分間隔を設定する 'second': 3, # 繰り返しの秒間隔を設定する 'repetition_type': 'every' # Every Cron用の繰り返しタイプをeveryに設定する }, 'job_meta': job_meta # Functionジョブメタデータを設定する }) <br> ### 日次Cronの作成 以下のSDKを使用して、**日次間隔**で固定時間にジョブを送信するCronをジョブプールにスケジュールできます。 注意: 以下のSDKは、毎日0時0分0秒にCronを実行するように構成されています。cron_detail JSONキーバリューペアに関連する値を渡すことで、要件に応じてこの値を変更できます。 # Functionジョブメタデータを作成する job_meta = { 'job_name': 'test_job', # ジョブの名前を設定する 'target_type': 'Function', # 関数ジョブのターゲットタイプをFunctionに設定する 'target_name': 'target_function', # ターゲット関数の名前を設定する（オプション）（target_idまたはtarget_nameは必須） # 'target_id': '123467890', # ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須） 'jobpool_name': 'test', # 関数ジョブプールの名前を設定する（オプション）（jobpool_nameまたはjobpool_idは必須） # 'jobpool_id': '1234567890' # 関数ジョブプールのIDを設定する（オプション）（jobpool_nameまたはjobpool_idは必須） 'job_config': { 'number_of_retries': 2, # リトライ回数を設定する 'retry_interval': 15 * 60 # リトライ間隔を設定する }, # ジョブ設定 - リトライ => 15分で2回リトライ（オプション） 'params': { 'arg1': 'test', 'arg2': 'job' } # ターゲット関数に渡すパラメータを設定する（オプション） } daily_cron = job_scheduling.CRON.create({ 'cron_name': 'daily_cron', # Cronの名前を設定する（一意） 'description': 'daily_cron', # Cronの説明を設定する（オプション） 'cron_status': True, # Cronのステータスを有効に設定する 'cron_type': 'Calendar', # CronタイプをCronExpressionに設定する 'cron_detail': { 'hour': 0, # Cronを実行する時を設定する 'minute': 0, # Cronを実行する分を設定する 'second': 0, # Cronを実行する秒を設定する 'repetition_type': 'daily', # Daily Cron用の繰り返しタイプをdailyに設定する # 'timezone': 'America/Los_Angeles' # タイムゾーンを設定する（オプション） }, 'job_meta': job_meta # Functionジョブメタデータを設定する }) <br> ### 月次Cronの作成 以下のSDKを使用して、**月次間隔**で固定の日付と時間にジョブを送信するCronをジョブプールにスケジュールできます。また、月次間隔で特定の週にジョブを送信するオプションもあります。 日付ベースのスケジュールで月次間隔でCronを実行するように選択した場合、**月**に基づく可能な日付の範囲は**1-31**です。同様に、**週ベース**の間隔を選択した場合、範囲は**1-4**で、特定の**曜日**は**1-7**の範囲になります。 注意: 以下のSDKは、0時0分0秒に毎月の1日、3日、5日にジョブプールにジョブを送信するCronを実行するように構成されています。cron_detail JSONキーバリューペアに関連する値を渡すことで、要件に応じてこの値を変更できます。 # Functionジョブメタデータを作成する job_meta = { 'job_name': 'test_job', # ジョブの名前を設定する 'target_type': 'Function', # 関数ジョブのターゲットタイプをFunctionに設定する 'target_name': 'target_function', # ターゲット関数の名前を設定する（オプション）（target_idまたはtarget_nameは必須） # 'target_id': '123467890', # ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須） 'jobpool_name': 'test', # 関数ジョブプールの名前を設定する（オプション）（jobpool_nameまたはjobpool_idは必須） # 'jobpool_id': '1234567890' # 関数ジョブプールのIDを設定する（オプション）（jobpool_nameまたはjobpool_idは必須） 'job_config': { 'number_of_retries': 2, # リトライ回数を設定する 'retry_interval': 15 * 60 # リトライ間隔を設定する }, # ジョブ設定 - リトライ => 15分で2回リトライ（オプション） 'params': { 'arg1': 'test', 'arg2': 'job' } # ターゲット関数に渡すパラメータを設定する（オプション） } # Monthly Cronを作成する monthly_cron = job_scheduling.CRON.create({ 'cron_name': 'monthly_cron', # Cronの名前を設定する（一意） 'description': 'monthly_cron', # Cronの説明を設定する（オプション） 'cron_status': True, # Cronのステータスを有効に設定する 'cron_type': 'Calendar', # CronタイプをCronExpressionに設定する 'cron_detail': { 'hour': 0, # Cronを実行する時を設定する 'minute': 0, # Cronを実行する分を設定する 'second': 0, # Cronを実行する秒を設定する 'days': [1, 3, 5], # Cronを実行する月の日を設定する # 'week_day': [1, 3], # Cronを実行する週の曜日を設定する # 'weeks_of_month': [2], # Cronを実行する月の週を設定する 'repetition_type': 'monthly', # Monthly Cron用の繰り返しタイプをmonthlyに設定する # 'timezone': 'America/Los_Angeles' # タイムゾーンを設定する（オプション） }, 'job_meta': job_meta # Functionジョブメタデータを設定する }) <br> ### 年次Cronの作成 以下のSDKを使用して、**年次**間隔で固定の月の固定の日付と時間にジョブを送信するCronをジョブプールにスケジュールできます。また、年次間隔で特定の週にジョブを送信するオプションもあります。 **年次**間隔の**日付ベース**のスケジュールでCronを実行するように選択した場合、**月**に基づく可能な日付の範囲は**1-31**で、**月**は**1-12**の値の範囲に基づいて決定されます。同様に、**週ベース**の間隔を選択した場合、範囲は**1-4**で、特定の**曜日**は**1-7**の範囲になります。 注意: 以下のSDKは、毎年の8月の1日、2日、3日にジョブプールにジョブを送信するCronを実行するように構成されています。cron_detail JSONキーバリューペアに関連する値を渡すことで、要件に応じてこの値を変更できます。 # Functionジョブメタデータを作成する job_meta = { "job_name": "test_job", # ジョブの名前を設定する "target_type": "Function", # 関数ジョブのターゲットタイプをFunctionに設定する "target_name": "target_function", # ターゲット関数の名前を設定する（オプション）（target_idまたはtarget_nameは必須） # 'target_id': '123467890', # ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須） "jobpool_name": "test", # 関数ジョブプールの名前を設定する（オプション）（jobpool_nameまたはjobpool_idは必須） # 'jobpool_id': '1234567890' # 関数ジョブプールのIDを設定する（オプション）（jobpool_nameまたはjobpool_idは必須） "job_config": { "number_of_retries": 2, # リトライ回数を設定する "retry_interval": 15 * 60, # リトライ間隔を設定する }, # ジョブ設定 - リトライ => 15分で2回リトライ（オプション） "params": { "arg1": "test", "arg2": "job", }, # ターゲット関数に渡すパラメータを設定する（オプション） } # Yearly Cronを作成する yearly_cron = job_scheduling.CRON.create( { "cron_name": "yearly_cron", # Cronの名前を設定する（一意） "description": "yearly_cron", # Cronの説明を設定する（オプション） "cron_status": True, # Cronのステータスを有効に設定する "cron_type": "Calendar", # CronタイプをCronExpressionに設定する "cron_detail": { "hour": 0, # Cronを実行する時を設定する "minute": 0, # Cronを実行する分を設定する "second": 0, # Cronを実行する秒を設定する "days": [ 1, 2, 3, ], # Cronを実行する月の日を設定する # 'week_day': [1, 3], # Cronを実行する週の曜日を設定する # 'weeks_of_month': [2], # Cronを実行する月の週を設定する "months": [ 8 ], # Cronを実行する年の月を設定する "repetition_type": "yearly", # Yearly Cron用の繰り返しタイプをyearlyに設定する # 'timezone': 'America/Los_Angeles' # タイムゾーンを設定する（オプション） }, "job_meta": job_meta, # Functionジョブメタデータを設定する } ) 注意: このSDKはダイナミックCronの構成にのみ使用することをお勧めします。事前定義Cronの構成にはUIビルダーを使用してください。 -------------------------------------------------------------------------------- title: "Cron式を使用したCronの作成" description: "このページでは、Cron式を使用してプロジェクト内でCronを作成するPythonメソッドをサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.361Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/cron/create-cron-cron-expressions/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/key-concepts/#cron-expressions) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/create-cron-cron-expressions/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/create-cron-cron-expressions/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/create-cron/create-cron-cron-exp/#CreateaCronUsingCronExpressions) -------------------------------------------------------------------------------- # Cron式を使用したCronの作成 このSDKを使用して、ジョブプールへのジョブ送信をスケジュールするCronを実装します。ただし、Cronの構成はCron式と呼ばれる正規表現のような式を使用して定義されます。 注意: 以下のSDKでは、Cron式を使用して、毎年の1月の毎週1日目の0時0分0秒にジョブプールにジョブを送信するようにCronが構成されています。cron_expression JSONキーバリューペアに関連する値を渡すことで、要件に応じてこの値を変更できます。 # Functionジョブメタデータを作成する job_meta = { 'job_name': 'test_job', # ジョブの名前を設定する 'target_type': 'Function', # 関数ジョブのターゲットタイプをFunctionに設定する 'target_name': 'target_function', # ターゲット関数の名前を設定する（オプション）（target_idまたはtarget_nameは必須） # 'target_id': '123467890', # ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須） 'jobpool_name': 'test', # 関数ジョブプールの名前を設定する（オプション）（jobpool_nameまたはjobpool_idは必須） # 'jobpool_id': '1234567890' # 関数ジョブプールのIDを設定する（オプション）（jobpool_nameまたはjobpool_idは必須） 'job_config': { 'number_of_retries': 2, # リトライ回数を設定する 'retry_interval': 15 * 60 # リトライ間隔を設定する }, # ジョブ設定 - リトライ => 15分で2回リトライ（オプション） 'params': { 'arg1': 'test', 'arg2': 'job' } # ターゲット関数に渡すパラメータを設定する（オプション） } # 式Cronを作成する expression_cron = job_scheduling.CRON.create({ 'cron_name': 'expression_cron', # Cronの名前を設定する（一意） 'description': 'expression_cron', # Cronの説明を設定する（オプション） 'cron_status': True, # Cronのステータスを有効に設定する 'cron_type': 'CronExpression', # CronタイプをCronExpressionに設定する 'cron_expression': '0 0 * 1 1', # Cron式を設定する # 'timezone': 'America/Los_Angeles', # タイムゾーンを設定する（オプション） 'cron_detail': {}, # Cron詳細を設定する 'job_meta': job_meta # Functionジョブメタデータを設定する }) 注意: このSDKはダイナミックCronの構成にのみ使用することをお勧めします。事前定義Cronの構成にはUIビルダーを使用してください。 -------------------------------------------------------------------------------- title: "特定のCronの詳細取得" description: "このページでは、プロジェクト内のCronの詳細を取得するためのPythonメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.361Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/cron/get-cron-details/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/get-cron-details/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/get-cron-details/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/get-cron/#GetCronByIdentifier) -------------------------------------------------------------------------------- # 特定のCronの詳細取得 以下のSDKを使用すると、特定の**事前定義Cron**または**動的Cron**の利用可能なすべての詳細を取得できます。cron idまたはCronの名前をget() SDKメソッドに渡す必要があります。 cron = job_scheduling.CRON.get('1234567890') # CronのIDでCronを取得する cron = job_scheduling.CRON.get('test') # Cronの名前でCronを取得する -------------------------------------------------------------------------------- title: "すべてのCronの詳細取得" description: "このページでは、プロジェクト内のすべてのCronの詳細を取得するためのPythonメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.361Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/cron/get-all-cron-details/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/get-all-cron-details/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/get-all-cron-details/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/get-all-cron/#GetAllCrons) -------------------------------------------------------------------------------- # すべてのCronの詳細取得 以下のSDKを使用すると、get_all() SDKメソッドを使用して、すべての事前定義Cronに関する利用可能なすべての情報を取得できます。 注意: このメソッドは事前定義Cronの詳細のみを取得します。このメソッドは動的Cronには対応していません。 all_cron = job_scheduling.CRON.get_all() # すべての静的Cronを取得する -------------------------------------------------------------------------------- title: "Cronの更新" description: "このページでは、プロジェクト内のCronを更新するためのPythonメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.361Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/cron/update-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/update-cron/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/update-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/update-cron/update-one-time-cron/#UpdateaOne-TimeCron) -------------------------------------------------------------------------------- # Cronの更新 以下のSDKを使用すると、特定のCronの詳細を更新できます。このSDKを使用して、名前、説明、ターゲットを更新できます。cron idをget()メソッドに渡して必要なCronを選択し、update()メソッドを使用して詳細を更新できます。 注意: このメソッドは、事前定義Cronと動的Cronの両方の詳細を更新するために使用できます。 cron = job_scheduling.CRON.get('test') # Cronの名前でCronを取得する cron.&#95;&#95;setitem&#95;&#95;('cron_name', 'test_new_name') # Cron名を設定する updated_cron = job_scheduling.CRON.update('1234567890', cron) # CronのIDでCron名を更新する cron = job_scheduling.CRON.get('test') # Cronの名前でCronを取得する cron.&#95;&#95;setitem&#95;&#95;('cron_name', 'test_name') # Cron名を設定する updated_cron = job_scheduling.CRON.update('test', cron) # 既存のcron名でcron名を更新する -------------------------------------------------------------------------------- title: "Cronの一時停止" description: "このページでは、プロジェクト内のCronを一時停止するためのPythonメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.361Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/cron/pause-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/pause-cron/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/pause-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/create-cron/create-one-time-cron/#CreateaOne-TimeCron) -------------------------------------------------------------------------------- # Cronの一時停止 このSDKメソッドは、Cronがジョブプールにジョブを送信するのを一時的に停止するために使用できます。一時停止したいCronのcron idまたは名前をpause() SDKメソッドに渡す必要があります。 注意: このメソッドは、事前定義Cronと動的Cronの両方の詳細を更新するために使用できます。 paused_cron = job_scheduling.CRON.pause('1234567890') # cron IDでcronを無効にする paused_cron = job_scheduling.CRON.pause('test_cron') # cron名でcronを無効にする -------------------------------------------------------------------------------- title: "Cronの再開" description: "このページでは、プロジェクト内のCronを再開するためのPythonメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.361Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/cron/resume-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/resume-cron/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/resume-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/create-cron/create-one-time-cron/#CreateaOne-TimeCron) -------------------------------------------------------------------------------- # Cronの再開 このSDKメソッドは、以前一時停止されたCronの操作を再開するために使用できます。一時停止されたcron idまたは名前をresume() SDKメソッドに渡すことで実行できます。 注意: このメソッドは、事前定義Cronと動的Cronの両方の詳細を更新するために使用できます。 resumed_cron = job_scheduling.CRON.resume('1234567890') # cron IDでcronを有効にする resumed_cron = job_scheduling.CRON.resume('test_cron') # cron名でcronを有効にする -------------------------------------------------------------------------------- title: "Cronの実行" description: "このページでは、プロジェクト内のCronを実行するためのPythonメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.361Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/cron/run-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/run-cron/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/run-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/create-cron/create-one-time-cron/#CreateaOne-TimeCron) -------------------------------------------------------------------------------- # Cronの実行 このSDKは、Cronを実行するために使用できます。Cronが実行されると、関連付けられたジョブが即座にジョブプールに送信されます。cron idまたは名前をrun() SDKメソッドに渡すことで実行できます。 注意: このメソッドは、事前定義Cronと動的Cronの両方の詳細を更新するために使用できます。 job = job_scheduling.CRON.run('1234567890') # CronのIDでCronを実行する job = job_scheduling.CRON.run('test_cron') # Cronの名前でCronを実行する -------------------------------------------------------------------------------- title: "Cronの削除" description: "このページでは、プロジェクト内のCronを削除するためのPythonメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.361Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/cron/delete-cron/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/cron/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/cron/delete-cron/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/cron/delete-cron/) - REST API Collection (/ja/api/code-reference/job-scheduling/cron/delete-cron/#DeleteCron) -------------------------------------------------------------------------------- # Cronの削除 このSDKメソッドは、特定のCronを削除するために使用できます。cron idまたは名前をdelete() SDKメソッドに渡すことで実行できます。 注意: このメソッドは、事前定義Cronと動的Cronの両方の詳細を更新するために使用できます。 deleted_cron = job_scheduling.CRON.delete('1234567890') # CronのIDでCronを削除する deleted_cron = job_scheduling.CRON.delete('test_cron') # Cronの名前でCronを削除する ##### Job Pool -------------------------------------------------------------------------------- title: "すべてのジョブプールの詳細取得" description: "このページでは、プロジェクト内のすべてのジョブプールを取得するためのPythonメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.362Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/jobpool/get-all-jobpool/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/jobpool/get-all-job-pool/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/jobpool/get-all-jobpool/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-all-jobpool/#GetAllJobPools) -------------------------------------------------------------------------------- # すべてのジョブプールの詳細取得 以下のSDKを使用すると、利用可能なすべてのジョブプールに関する利用可能なすべての詳細を取得できます。 all_jobpools = job_scheduling.get_all_jobpool() # すべてのジョブプールを取得する -------------------------------------------------------------------------------- title: "特定のジョブプールの詳細取得" description: "このページでは、プロジェクト内の特定のジョブプールの詳細を取得するためのPythonメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.362Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/jobpool/get-job-pool/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/jobpool/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/jobpool/get-job-pool/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/jobpool/get-job-pool/) - REST API Collection (/ja/api/code-reference/job-scheduling/jobpool/get-jobpool/#GetJobPoolbyIdentifier) -------------------------------------------------------------------------------- # 特定のジョブプールの詳細取得 以下のSDKを使用すると、ジョブプールの名前またはIDをget_jobpool() SDKメソッドに渡すことで、特定のジョブプールの詳細を取得できます。 ### ジョブプールIDを使用したジョブプールの詳細取得 jobpool = job_scheduling.get_jobpool('1234567890') # ジョブプールID "1234567890"でジョブプールを取得する ### ジョブプール名を使用したジョブプールの詳細取得 jobpool = job_scheduling.get_jobpool('test') # ジョブプール名 "test"でジョブプールを取得する ##### Jobs -------------------------------------------------------------------------------- title: "ジョブの作成" description: "このページでは、プロジェクト内でジョブを作成するためのPythonメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.362Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/jobs/create-job/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/job/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/jobs/create-job/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/jobs/create-job/) - REST API Collection (/ja/api/code-reference/job-scheduling/job/submit-job/submit-webhook-job/#SubmitWebhookJobByID) -------------------------------------------------------------------------------- # ジョブの作成 以下のSDKメソッドを使用すると、ジョブFunction、Webhook、Circuit、およびAppSailサービスをトリガーするジョブを作成して送信できます。また、JSONキーバリューペアの形式でオプションの引数を渡すこともできます。 ジョブを作成して送信し、以下をトリガーするSDKスニペット: # Functionジョブを作成する function_job = job_scheduling.JOB.submit_job( { "job_name": "test_job", # ジョブの名前を設定する "jobpool_name": "test", # ジョブを送信するFunctionジョブプールの名前を設定する "target_type": "Function", # 関数ジョブのターゲットタイプをFunctionに設定する "target_name": "target_function", # ターゲット関数の名前を設定する（オプション）（target_idまたはtarget_nameは必須） # 'target_id': '123467890', # ターゲット関数のIDを設定する（オプション）（target_idまたはtarget_nameは必須） "params": { "arg1": "test", "arg2": "job", }, # ターゲット関数に渡すパラメータを設定する（オプション） "job_config": { "number_of_retries": 2, # リトライ回数を設定する "retry_interval": 15 * 60, # リトライ間隔を設定する }, # ジョブ設定 - リトライ => 15分で2回リトライ（オプション） } ) # Circuitジョブを作成する circuit_job = job_scheduling.JOB.submit_job( { "job_name": "test_job", # ジョブの名前を設定する "jobpool_name": "test", # ジョブを送信するCircuitジョブプールの名前を設定する "target_type": "Circuit", # サーキットジョブのターゲットタイプをCircuitに設定する "target_name": "target_circuit", # ターゲットサーキットの名前を設定する（オプション）（target_idまたはtarget_nameは必須） # 'target_id': '123467890', # ターゲットサーキットのIDを設定する（オプション）（target_idまたはtarget_nameは必須） "test_cases": {"arg1": "job", "arg2": "test"}, # サーキットのテストケースを設定する "job_config": { "number_of_retries": 2, # リトライ回数を設定する "retry_interval": 15 * 60, # リトライ間隔を設定する }, # ジョブ設定 - リトライ => 15分で2回リトライ（オプション） } ) # Webhookジョブを作成する webhook_job = job_scheduling.JOB.submit_job( { "job_name": "test_job", # ジョブの名前を設定する "jobpool_name": "test", # ジョブを送信するWebhookジョブプールの名前を設定する "target_type": "Webhook", # WebhookジョブのターゲットタイプをWebhookに設定する "request_method": "POST", # Webhookリクエストのメソッドを設定する "url": "https://catalyst.zoho.com", # WebhookリクエストのURLを設定する "params": { "arg1": "test", "arg2": "job", }, # Webhookリクエストのクエリパラメータを設定する（オプション） "headers": { "IS_TEST_REQUEST": "true" }, # Webhookリクエストのヘッダーを設定する（オプション） "request_body": "test_request", # Webhookリクエストのボディを設定する（オプション） "job_config": { "number_of_retries": 2, # リトライ回数を設定する "retry_interval": 15 * 60, # リトライ間隔を設定する }, # ジョブ設定 - リトライ => 15分で2回リトライ（オプション） } ) # AppSailジョブを作成する appsail_job = job_scheduling.JOB.submit_job( { "job_name": "test_job", # ジョブの名前を設定する "jobpool_name": "test", # ジョブを送信するAppSailのジョブプール名を設定する "target_type": "AppSail", # AppSailジョブのターゲットタイプをAppSailに設定する "target_name": "target_appsail", # ターゲットAppSailの名前を設定する（オプション）（target_idまたはtarget_nameは必須） # 'target_id': '123467890', # ターゲットAppSailのIDを設定する（オプション）（target_idまたはtarget_nameは必須） "request_method": "POST", # AppSailリクエストのメソッドを設定する "url": "/test", # AppSailのURLパスを設定する（オプション） "params": { "arg1": "test", "arg2": "job", }, # AppSailリクエストのクエリパラメータを設定する（オプション） "headers": { "IS_TEST_REQUEST": "true" }, # AppSailリクエストのヘッダーを設定する（オプション） "request_body": "test_request", # AppSailリクエストのボディを設定する（オプション） "job_config": { "number_of_retries": 2, # リトライ回数を設定する "retry_interval": 15 * 60, # リトライ間隔を設定する }, # ジョブ設定 - リトライ => 15分で2回リトライ（オプション） } ) -------------------------------------------------------------------------------- title: "ジョブの詳細取得" description: "このページでは、プロジェクト内のジョブの詳細を取得するためのPythonメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.362Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/jobs/get-job/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/job/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/jobs/get-job/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/jobs/get-job/) - REST API Collection (/ja/api/code-reference/job-scheduling/job/get-job/#GetJobByID) -------------------------------------------------------------------------------- # ジョブの詳細取得 以下のSDKメソッドを使用すると、ジョブプールに送信されたジョブに関する利用可能なすべての詳細を取得できます。Job Idをget_job() SDKメソッドに渡す必要があります。 job = job_scheduling.JOB.get_job('1234567890') # ジョブIDでジョブを取得する -------------------------------------------------------------------------------- title: "ジョブの削除" description: "このページでは、プロジェクト内のジョブを削除するためのPythonメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.362Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/job-scheduling/jobs/delete-job/" service: "Job Scheduling" related: - Component Help Documentation (/ja/job-scheduling/help/job/introduction/) - Java SDK (/ja/sdk/java/v1/job-scheduling/jobs/delete-job/) - Node.js SDK (/ja/sdk/nodejs/v2/job-scheduling/jobs/delete-job/) - REST API Collection (/ja/api/code-reference/job-scheduling/job/delete-job/#DeleteJobbyID) -------------------------------------------------------------------------------- # ジョブの削除 以下のSDKメソッドを使用すると、ジョブプールで実行中のジョブを削除できます。Job Idをdelete_job() SDKメソッドに渡す必要があります。 job = job_scheduling.JOB.delete_job('1234567890') # IDでジョブを削除する #### Pipelines -------------------------------------------------------------------------------- title: "パイプラインインスタンスの取得" description: "このページでは、パイプラインインスタンスを取得して他のパイプライン操作に使用する方法を説明します。" last_updated: "2026-06-10T06:04:54.362Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/pipelines/get-pipeline-instance/" service: "All Services" related: - Catalyst Pipelines (/ja/pipelines/help/pipelines/introduction) - Create a Pipeline (/ja/pipelines/help/pipelines/create-a-pipeline) - Java SDK (/ja/sdk/java/v1/pipelines/get-pipeline-instance) - NodeJS SDK (/ja/sdk/nodejs/v2/pipelines/get-pipeline-instance) - REST API (/ja/api/code-reference/pipelines/get-pipeline-details) -------------------------------------------------------------------------------- # Catalyst Pipelines Catalyst Pipelinesは、CI/CDアプローチを実装し、WebまたはモバイルアプリケーションのビルドBuild、テスト、および優先環境へのデプロイの自動化を可能にします。 Catalystコンソールからパイプラインを作成できます。以下のSDKを使用して、Catalyst Pipelineの詳細を取得したり、アプリケーションにコードスニペットを組み込んでパイプラインを実行したりできます。 # パイプラインインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに固有のプロパティにアクセスするために使用できるオブジェクトです。Catalyst Pipelinesで以下にリストされているアクションを実行するためのコンポーネントインスタンスを作成できます。 以下のコードで使用されているappリファレンスは、SDK初期化時にレスポンスとして返されるPythonオブジェクトです。以下に示すように、新しいpipelines_serviceインスタンスを作成できます。 pipelines_service = app.pipeline() このコンポーネントインスタンスは、Node.js SDKのすべてのPipeline操作で使用されます。 -------------------------------------------------------------------------------- title: "パイプラインの詳細取得" description: "このページでは、既存のCatalyst Pipelineのすべての詳細を取得する方法を説明します。" last_updated: "2026-06-10T06:04:54.362Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/pipelines/get-pipeline-details/" service: "All Services" related: - Catalyst Pipelines (/ja/pipelines/help/pipelines/introduction) - Create a Pipeline (/ja/pipelines/help/pipelines/create-a-pipeline) - Java SDK (/ja/sdk/java/v1/pipelines/get-pipeline-instance) - NodeJS SDK (/ja/sdk/nodejs/v2/pipelines/get-pipeline-instance) - REST API (/ja/api/code-reference/pipelines/get-pipeline-details) -------------------------------------------------------------------------------- # パイプラインの詳細取得 パイプラインIDをパラメータとしてget_pipeline_details()メソッドに渡すことで、Catalyst Pipelineの詳細を取得できます。パイプラインの名前、パイプラインが作成されたCatalystプロジェクトの詳細、パイプラインを作成したユーザーの詳細、作成日時、変更が行われた場合はパイプラインを変更したユーザーの詳細、変更日時、パイプラインのステータス、およびランナー仕様などのその他の詳細がこのメソッドのレスポンスとして返されます。 以下で使用されているpipelines_serviceリファレンスは、このコンポーネントインスタンスページですでに定義されています。 pipeline_details = pipelines_service.get_pipeline_details("16965000000027475") サンプルレスポンスを以下に示します： { "status": "success", "data": { "pipeline_id": "16965000000027475", "name": "test1", "project_details": { "project_name": "Project-Rainfall", "id": "5000000000072", "project_type": "Live" }, "created_by": { "zuid": "20257791", "is_confirmed": false, "email_id": "amelia.burrows@zylker.com", "first_name": "Amelia", "last_name": "Burrows", "user_type": "Admin", "user_id": "5000000000056" }, "created_time": "Mar 19, 2024 11:28 AM", "modified_by": { "zuid": "20257791", "is_confirmed": false, "email_id": "amelia.burrows@zylker.com", "first_name": "Amelia", "last_name": "Burrows", "user_type": "Admin", "user_id": "5000000000056" }, "modified_time": "Mar 19, 2024 11:28 AM", "git_account_id": "", "mask_regex": [ null ], "pipeline_status": "Active", "config_id": 2, "integ_id": 1 } } -------------------------------------------------------------------------------- title: "パイプラインの実行" description: "このページでは、Catalyst Pipelineを手動で実行する方法を説明します。" last_updated: "2026-06-10T06:04:54.362Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/pipelines/execute-pipeline/" service: "All Services" related: - Catalyst Pipelines (/ja/pipelines/help/pipelines/introduction) - Create a Pipeline (/ja/pipelines/help/pipelines/create-a-pipeline) - Java SDK (/ja/sdk/java/v1/pipelines/get-pipeline-instance) - NodeJS SDK (/ja/sdk/nodejs/v2/pipelines/get-pipeline-instance) - REST API (/ja/api/code-reference/pipelines/get-pipeline-details) -------------------------------------------------------------------------------- # パイプラインの実行 パイプラインIDとブランチ名をパラメータとしてrun_pipeline()メソッドに渡すことで、Catalystパイプラインの実行を開始できます。また、パイプライン実行に必要な環境変数をJSONオブジェクトでこのメソッドに渡すこともできますが、これは完全にオプションです。このメソッドは、パイプラインの実行履歴の詳細をレスポンスとして返します。 以下で使用されているpipelines_serviceリファレンスは、このコンポーネントインスタンスページですでに定義されています。 execution_details = pipelines_service.run_pipeline("18014000000023048", "main", {"EVENT": "push","URL":"https://www.google.com"}) サンプルレスポンスを以下に示します： { "status": "success", "data": { "history_id": "5000000021007", "pipeline_id": "18014000000023048", "event_time": "Mar 20, 2024 02:02 PM", "event_details": { "BRANCH_NAME": "main", "EVENT": "push", "URL": "https://www.google.com" }, "history_status": "Queued" } } #### QuickML -------------------------------------------------------------------------------- title: "QuickMLエンドポイントの実行" description: "このページでは、PythonアプリケーションでQuickMLエンドポイントを実行する方法をサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.362Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/quickml/execute-quickml-endpoints/" service: "QuickML" related: - QuickML Help (/ja/quickml/) - QuickML Pipeline Endpoints (/ja/quickml/help/pipeline-endpoints/) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Catalyst QuickML Catalyst QuickMLは、ノーコードの機械学習パイプラインビルダーサービスで、事前構築されたMLアルゴリズム、操作、データ前処理技術のホストを実装し、データセットに接続してMLモデルを構築および公開できます。MLパイプラインを公開した後、認証済みのエンドポイントで作成したモデルにアクセスできます。 ### QuickMLエンドポイントの実行 以下のコードスニペットを使用すると、公開されたQuickMLエンドポイントに入力データを渡し、MLモデルの処理に基づいて結果を予測できます。出力は、MLパイプライン作成時に定義されたターゲット列の値の予測を返します。 注意: 1. 以下のコードスニペットで結果を予測するには、Catalystコンソールを使用してプロジェクト内でMLパイプラインとモデルのエンドポイントを構成および公開しておく必要があります。 2. QuickMLは現在、JP、SA、またはCAデータセンターからアクセスするCatalystユーザーには利用できません。 quickmlコンポーネントインスタンスは以下のように作成されます。これはサーバーサイドの呼び出しを実行しません。モデルのエンドポイントにキーバリューペアとして入力データを渡すデータディクショナリを作成する必要があります。以下のendpoint_keyは、プロジェクトで構成されたMLモデルに対して公開されたエンドポイントの一意のIDです。エンドポイントキーと入力データは、実行のためにpredict()メソッドに渡されます。以下のコードで使用されているappリファレンスは、SDK初期化時にレスポンスとして返されるPythonオブジェクトです。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>endpoint_key</td> <td>必須パラメータ。MLモデルに対して公開されたエンドポイントの一意のIDを格納します。</td> </tr> <tr> <td>input_data</td> <td>必須パラメータ。QuickMLエンドポイントに公開するデータを格納します。</td> </tr> </tbody> </table> # 入力データ辞書 input_data = { # データセットに応じてカラム名と値を指定する "column_name1": "value1", "column_name2": "value2", "column_name3": "value3", } #QuickMLインスタンスを作成する quickml = app.quick_ml() #メソッドを実行する result = quickml.predict("{endpoint_key}", input_data) #{endpoint_key}をCatalystコンソールからコピーしたエンドポイントキーに置き換える print(result) 受信される出力の構文を以下に示します： { "status":"success", "result":[ "results....." ] } 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 #### Serverless ##### AppSail -------------------------------------------------------------------------------- title: "AppSailでのSDK実装" description: "このページでは、AppSailサービスにPython SDKを実装し、アプリケーション内でCatalyst機能を利用する方法について説明します。" last_updated: "2026-06-10T06:04:54.363Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/serverless/appsail/implement-sdk-in-appsail/" service: "Serverless" related: - AppSail Help (/ja/serverless/help/appsail/introduction) -------------------------------------------------------------------------------- # Catalyst AppSail Catalyst AppSailは、Catalyst Serverlessのフルマネージドで独立したPlatform-as-a-Service（PaaS）コンポーネントであり、クラウドでのサービスの開発とデプロイを容易に行うことができます。AppSailアプリケーションはCatalyst固有のコーディング構造に依存せずに構築でき、Catalystはこの目的のために強力でスケーラビリティの高いプラットフォームを提供します。AppSailは、Flask、Django、Bottle、CherryPyなど、Pythonのすべてのフレームワークをサポートしています。 # AppSailでのPython SDKの実装 AppSailサービスのコードベースにCatalyst Python SDKを簡単に実装できます。SDKは、各リクエストの前にリクエストオブジェクトで初期化する必要があります。 以下は、Flask WebアプリでPython SDKをインポートして初期化する例です。 from flask import Flask, request, g import os import zcatalyst_sdk from zcatalyst_sdk.catalyst_app import CatalystApp app = Flask(__name__) @app.before_request def before_request(): if request.path.startswith('/admin'): return 'Unauthorized', 401 # 認証済みユーザーの場合 g.zc_app = zcatalyst_sdk.initialize(req=request) @app.route('/') def index(): return 'Web App with Python Flask!' @app.route('/cache') def cache(): app: CatalystApp = g.zc_app resp = app.cache().segment().put('key', 'value') return resp, 200 listen_port = os.getenv('X_ZOHO_CATALYST_LISTEN_PORT', 9000) app.run(host='0.0.0.0', port = listen_port) 情報 : 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 ##### Circuits -------------------------------------------------------------------------------- title: "コンポーネントインスタンスの取得" description: "このページでは、サンプルコードスニペットを使用して、Pythonアプリケーションでサーキットを使用してタスクを整理・オーケストレーションする方法について説明します。" last_updated: "2026-06-10T06:04:54.363Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/serverless/circuits/get-a-component-instance/" service: "Serverless" related: - Circuits Help (/ja/serverless/help/circuits/introduction) -------------------------------------------------------------------------------- # Circuits Catalyst Serverless Circuitsは、タスクのオーケストレーションとワークフローの自動化を支援するCatalyst開発プラットフォームの一部であるコンポーネントです。サーキット内でCatalyst関数の同時実行または順次実行を有効にし、さらにワークフローに条件、データ、パスを含めて、ビジネス成果を達成する繰り返し可能なアクティビティのパターンを定義できます。このセクションでは、Catalystアプリケーションでサーキットコンポーネントを実装するために使用できるさまざまなSDKメソッドについて説明します。 注意: Circuitsは現在、EU、AU、IN、JP、SA、またはCAデータセンターからアクセスするCatalystユーザーには利用できません。 #### コンポーネントインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに固有の定義済み設定にアクセスするために使用できるオブジェクトです。このプロセスはサーバーサイドの呼び出しを発行しません。 以下のコードで使用されているapp参照は、SDKの初期化時にレスポンスとして返されるPythonオブジェクトです。以下のように新しいcircuitインスタンスを作成できます。また、このコンポーネントインスタンスは、アプリケーションでサーキットコンポーネントを実装する際のさまざまなシナリオで使用されることに注意してください。 #Circuitコンポーネントインスタンスを取得する circuit = app.circuit() -------------------------------------------------------------------------------- title: "サーキットの実行" description: "このページでは、サンプルコードスニペットを使用して、Pythonアプリケーションでサーキットを使用してタスクを整理・オーケストレーションする方法について説明します。" last_updated: "2026-06-10T06:04:54.363Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/serverless/circuits/execute-circuit/" service: "Serverless" related: - Execute Circuit - API (/ja/api/code-reference/serverless/circuits/execute-circuit/#ExecuteCircuit) - Circuits Help (/ja/serverless/help/circuits/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- ### サーキットの実行 以下のサンプルコードは、一意のサーキットIDを参照し、辞書形式でサーキットへの入力としてキーと値のペアを渡してサーキットを実行する方法を示しています。 以下で使用されているコンポーネントインスタンスcircuit_serviceの詳細については、こちらのヘルプセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>circuit ID</td> <td>Numeric</td> <td>必須パラメータです。実行するサーキットの一意のIDを格納します。</td> </tr> <tr> <td>circuit input</td> <td>Object</td> <td>必須パラメータです。サーキットへの入力を含む辞書を格納します。</td> </tr> </tbody> </table> #Circuitを実行する circuit = app.circuit() result = circuit.execute(5249000000108030, name="Test_Circuit") サンプルレスポンスを以下に示します： { "id":"5249000000108030", "name":"Test_Circuit", "start_time":"Aug 18, 2021 07:35 PM", "status":"running", "status_code":1, "execution_meta":{ }, "circuit_details":{ "name":"Test_Circuit", "ref_name":"testcircuit", "description":"", "instance_id":"70454fc5-3bf6-45af-81ca-2742cc049698" }, "input":{ "name":"Aaron Jones" } } 情報 : 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 ##### ファンクション -------------------------------------------------------------------------------- title: "コンポーネントインスタンスの取得" description: "このページでは、サンプルコードスニペットを使用して、Pythonアプリケーションで関数を実行する方法について説明します。" last_updated: "2026-06-10T06:04:54.363Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/serverless/functions/get-component-instance/" service: "Serverless" related: - Functions Help (/ja/serverless/help/functions/introduction) -------------------------------------------------------------------------------- # Functions Catalyst Serverless Functionsは、Catalystアプリケーションのビジネスロジックを含むカスタムビルドのコーディング構造です。CatalystコンソールまたはCLIを使用して作成できます。このセクションでは、Catalystアプリケーションで関数を実装するために使用できるさまざまなSDKメソッドについて説明します。 #### コンポーネントインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに固有の定義済み設定にアクセスするために使用できるオブジェクトです。このプロセスはサーバーサイドの呼び出しを発行しません。 以下のコードで使用されているapp参照は、SDKの初期化時にレスポンスとして返されるPythonオブジェクトです。以下のように新しいfunction_serviceインスタンスを作成できます。このコンポーネントインスタンスは、次のセクションで関数を実行する際に使用されます。 #Functionコンポーネントインスタンスを取得する function_service = app.functions() -------------------------------------------------------------------------------- title: "関数の実行" description: "このページでは、サンプルコードスニペットを使用して、Pythonアプリケーションで関数を実行する方法について説明します。" last_updated: "2026-06-10T06:04:54.363Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/serverless/functions/execute-function/" service: "Serverless" related: - Execute Function - API (/ja/api/code-reference/serverless/functions/execute-function/#ExecuteFunction) - Functions Help (/ja/serverless/help/functions/introduction) -------------------------------------------------------------------------------- # 関数の実行 関数は、関数IDと設定（辞書型）をパラメータとして渡すexecute()メソッドを呼び出すことで実行できます。以下で使用されているコンポーネントインスタンスfunction_serviceの詳細については、こちらのヘルプセクションを参照してください。 関数を実行する前に、関数に必要な設定を行う必要があります。ここでの設定は、関数の引数とその値を指定します。 一意のfunctionIDがexecute()メソッドにパラメータとして渡され、必要な設定で実行する関数を呼び出します。 設定は以下のコードスニペットを使用して行えます： **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>function_ID</td> <td>Numeric</td> <td>必須パラメータです。実行する関数の一意のIDを格納します。</td> </tr> <tr> <td>function_config</td> <td>Object</td> <td>必須パラメータです。実行する関数の設定を格納します。</td> </tr> </tbody> </table> function_service = app.functions() args = {"Name": "Amelia"} return_value = function_service.execute(5249000000015567, args) 情報 : 1. 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 2. 関数IDの代わりに、関数名を文字列としてexecute()メソッドに渡すこともできます。 #### SmartBrowz -------------------------------------------------------------------------------- title: "SmartBrowzインスタンスの作成" description: "このページでは、SmartBrowzインスタンスを作成する方法を説明します。" last_updated: "2026-06-10T06:04:54.363Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/smartbrowz/create-smartbrowz-instance/" service: "SmartBrowz" related: - SmartBrowz Help (/ja/smartbrowz/getting-started/introduction/) -------------------------------------------------------------------------------- # Catalyst SmartBrowz Catalyst SmartBrowzコンポーネントを使用すると、ヘッドレスブラウザを制御・管理し、WebページのPDFやスクリーンショットの生成、動的コンテンツを含むPDFを生成するためのテンプレートの作成、強力なCatalyst APIを使用したWebからのデータ抽出など、さまざまな操作を実行できます。 ### SmartBrowzインスタンスの作成 コンポーネントインスタンスは、特定のコンポーネントに固有のプロパティにアクセスするために使用できるオブジェクトです。SmartBrowzでヘッドレスアクションを実行するためのコンポーネントインスタンスを作成できます。 以下のコードで使用されているappリファレンスは、SDK初期化時にレスポンスとして返されるPythonオブジェクトです。以下に示すように、新しいsmart_browzインスタンスを作成できます。 smart_browz = app.smart_browz() このコンポーネントインスタンスは、Python SDKのすべてのSmartBrowz操作で使用されます。 注意: Browser Logic関数を使用してコーディングするブラウザのアクションや操作、またはCatalyst SmartBrowzの任意のコンポーネントを使用して実行するブラウザの自動化やWebスクレイピングタスクは、すべてお客様自身の責任で行われます。SmartBrowzコンポーネントは、操作を許可するドメインで、または適切な承認を得て操作を実行するために使用することを強くお勧めします。また、Catalystは関数をコーディングするための安全なインフラストラクチャを提供しますが、Catalyst関数を使用してコーディングしたロジックの結果はお客様のみの責任となります。 -------------------------------------------------------------------------------- title: "PDFとスクリーンショット" description: "このページでは、PDFとスクリーンショットを生成する方法を説明します。" last_updated: "2026-06-10T06:04:54.363Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/smartbrowz/generate-pdfnscreenshot/" service: "SmartBrowz" related: - PDF & Screenshot - API (/ja/api/code-reference/smartbrowz/generate-pdfnscreenshoturl/#PDF%26ScreenshotwithHTML%2fURLasInput) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # PDF & Screenshot Catalyst SmartBrowzは、コードを通じて好みのビジュアルドキュメントを生成するためのPDF & Screenshotコンポーネントを提供します。以下のコードをコピーしてアプリケーションロジックに貼り付けることで、この機能をアプリケーションに組み込むことができます。 以下のSDKを使用して、HTML、URL、またはテンプレートを入力として使用してビジュアルドキュメントを生成できます。 以下で使用されているコンポーネントインスタンスsmart_browzの詳細については、こちらのヘルプセクションを参照してください。 # テンプレートからPDFまたはスクリーンショットを生成 smart_browz = app.smart_browz() result = smart_browz.generate_from_template( "153000000009001", # テンプレートIDを置き換える template_data={}, output_options={"output_type": "pdf"}, pdf_options={ "scale": 1, "display_header_footer": true, "print_background": false, "landscape": false, "page_ranges": "1", "format": "A4", "width": "100", "height": "100", "omit_background": false, "password": "Demo$", }, page_options={ "css": {"content": "body{background: lightgrey}"}, "viewport": {"width": 1440, "height": 900}, "javascript_enabled": true, }, navigation_options={"timeout": 5000, "wait_until": "networkidle0"}, ) # HTMLからPDFに変換 smart_browz = app.smart_browz() result = smart_browz.convert_to_pdf( "<h1>Welcome</h1>", pdf_options={ "scale": 1, "display_header_footer": true, "print_background": false, "landscape": false, "page_ranges": "1", "format": "A4", "width": "100", "height": "100", "omit_background": false, "password": "Demo$", }, page_options={ "css": {"content": "body{background: lightgrey}"}, "viewport": {"width": 1440, "height": 900}, "javascript_enabled": true, }, navigation_options={"timeout": 5000, "wait_until": "networkidle0"}, ) # URLからPDFを生成 smart_browz = app.smart_browz() result = smart_browz.convert_to_pdf( "https://catalyst.zoho.com/", pdf_options={ "scale": 1, "display_header_footer": true, "print_background": false, "landscape": false, "page_ranges": "1", "format": "A4", "width": "100", "height": "100", "omit_background": false, "password": "Demo$", }, page_options={ "css": {"content": "body{background: lightgrey}"}, "viewport": {"width": 1440, "height": 900}, "javascript_enabled": true, }, navigation_options={"timeout": 5000, "wait_until": "networkidle0"}, ) # HTMLからスクリーンショットを撮影 smart_browz = app.smart_browz() output_screenshot = smart_browz.take_screenshot( source='<h1>Welcome</h1>', "output_options": { "output_type": "screenshot" }, screenshot_options= { "type": "jpeg", "quality": 100, "full_page": false, "omit_background": false, "capture_beyond_viewport": true, "clip": { "x": 50, "y": 100, "width": 1000, "height": 100 } }, page_options= { "css": { "content": "body{background: lightgrey}" }, "viewport": { "width": 1440, "height": 900 "viewport": { "width": 1440, "height": 900 }, "javascript_enabled": true "javascript_enabled": true }, navigation_options= { "timeout": 5000, "wait_until": "networkidle0" "navigation_options": { "timeout": 5000, "wait_until": "networkidle0" } } }) # URLからスクリーンショットを撮影 smart_browz = app.smart_browz() output_screenshot = smart_browz.take_screenshot( source='YOUR_URL', "output_options": { "output_type": "screenshot" }, screenshot_options= { "type": "jpeg", "quality": 100, "full_page": false, "omit_background": false, "capture_beyond_viewport": true, "clip": { "x": 50, "y": 100, "width": 1000, "height": 100 } }, page_options= { "css": { "content": "body{background: lightgrey}" }, "viewport": { "width": 1440, "height": 900 "viewport": { "width": 1440, "height": 900 }, "javascript_enabled": true "javascript_enabled": true }, navigation_options= { "timeout": 5000, "wait_until": "networkidle0" "navigation_options": { "timeout": 5000, "wait_until": "networkidle0" } } }) コンソールのPDF & Screenshotセクションでは、Playground機能を使用してこのコンポーネントを直接テストでき、コンソールから直接SDKをコピーすることもできます。 注意: Browser Logic関数を使用してコーディングするブラウザのアクションや操作、またはCatalyst SmartBrowzの任意のコンポーネントを使用して実行するブラウザの自動化やWebスクレイピングタスクは、すべてお客様自身の責任で行われます。SmartBrowzコンポーネントは、操作を許可するドメインで、または適切な承認を得て操作を実行するために使用することを強くお勧めします。また、Catalystは関数をコーディングするための安全なインフラストラクチャを提供しますが、Catalyst関数を使用してコーディングしたロジックの結果はお客様のみの責任となります。 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "Dataverse" description: "このページでは、Catalyst DataverseモジュールのSDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.363Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/smartbrowz/dataverse/" service: "SmartBrowz" related: - Dataverse Help (/ja/smartbrowz/help/dataverse/introduction/) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Dataverse Dataverseは、Catalyst SmartBrowzのコンポーネントで、スクレイピングを通じてWebからデータを抽出します。Dataverseが提供する3つのカテゴリのデータ抽出機能を以下に説明します。 注意: Web上で公開されている情報のみの提供を保証します。 1. **リードエンリッチメント** リードエンリッチメントモジュールを使用すると、Webから特定の組織の詳細を取得できます。情報を取得するために、組織の名前、メールアドレス、またはWebサイトURLをパラメータとしてget_enriched_lead()メソッドに提供する必要があります。 注意: get_enriched_lead()メソッドで少なくとも1つのキーに値を指定する必要があります。 以下で使用されているsmart_browzリファレンスは、先ほど作成したコンポーネントインスタンスです。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>lead_details</td> <td>Array</td> <td>必須パラメータ。Webから収集するリードの詳細を格納します。</td> </tr> </tbody> </table> smart_browz = app.smart_browz() response = smart_browz.get_enriched_lead( { "email": "sales@zohocorp.com", "lead_name": "zoho", "website_url": "https://www.zoho.com", } ) print(response) レスポンスを以下に示します： [ { "employee_count":"12000", "website":"https://www.zoho.com", "address":[ { "country":"India", "pincode":"603202", "city":"Chengalpattu District", "street":"Estancia It Park, Plot No. 140 151, Gst Road Vallancheri", "state":"Tamil Nadu", "id":"Estancia IT Park, Plot no. 140, 151, GST Road, Vallancheri, Chennai." } ], "social":{ "twitter":[ "twitter.com/zoho" ] }, "source_language":"en", "description":"Zoho Corporation offers web-based business applications.", "organization_name":"ZOHO", "ceo":"Sridhar Vembu", "headquarters":[ { "country":"India" } ], "revenue":"$1B", "years_in_industry":"27", "about_us":"https://www.zoho.com/aboutus.html?ireft=nhome&src=home1", "founding_year":"1996", "contact":[ "844-316-5544", "0800-085-6099" ], "industries":{ "computer programming services":"Includes data processing services and other computer related services." }, "logo":"https://www.zohowebstatic.com/sites/zweb/images/ogimage/zoho-logo.png", "organization_type":[ "Private Limited Company" ], "business_model":[ "B2B" ], "email":[ "sales@zohocorp.com", "press@zohocorp.com" ], "organization_status":"LARGE_ENTERPRISE", "territory":[ "India", "United States of America" ], "sign_up_link":"https://www.zoho.com/signup.html?all_prod_page=true" } ] 2. **テックスタックファインダー：** テックスタックファインダーモジュールを使用すると、組織が実装しているテクノロジーや使用しているフレームワークの詳細を取得できます。情報を取得するために、組織のWebサイトURLをパラメータとしてfind_tech_stack()メソッドに提供する必要があります。 以下で使用されているsmart_browzリファレンスは、先ほど作成したコンポーネントインスタンスです。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>org_url</td> <td>String</td> <td>必須パラメータ。テックスタックの詳細が必要な組織のURLを格納します。</td> </tr> </tbody> </table> smart_browz = app.smart_browz() response = smart_browz.find_tech_stack('https://www.zoho.com') print(response) レスポンスを以下に示します： [ { "website":"https://www.zoho.com", "technographic_data":{ "audio-video media":"Vimeo,YouTube", "ssl_certificate":"Sectigo Limited", "email hosting providers":"Zoho Mail,SPF" }, "organization_name":"ZOHO" } ] 3. **類似企業：** 類似企業モジュールを使用すると、入力として指定した組織と同じまたは類似のサービスを提供する潜在的な組織のリストを取得できます。入力組織の名前またはWebサイトURLのいずれかをパラメータとしてget_similar_companies()メソッドに提供できます。 以下で使用されているコンポーネントインスタンスsmart_browzの詳細については、こちらのヘルプセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>company_url</td> <td>String</td> <td>必須パラメータ。類似組織を取得する対象の組織のURLを格納します。</td> </tr> </tbody> </table> smart_browz = app.smart_browz() response = smart_browz.get_similar_companies( {"lead_name": "zoho", "website_url": "https://www.zoho.com"} ) print(response) [ "Cybage Software Pvt. Ltd.", "Google LLC", "Chargebee, Inc.", "Infosys Ltd.", "GlobalLogic Inc.", "Persistent Systems Ltd.", "DELTA ELECTRONICS Inc.", "Salesforce, Inc." ] 注意: Browser Logic関数を使用してコーディングするブラウザのアクションや操作、またはCatalyst SmartBrowzの任意のコンポーネントを使用して実行するブラウザの自動化やWebスクレイピングタスクは、すべてお客様自身の責任で行われます。SmartBrowzコンポーネントは、操作を許可するドメインで、または適切な承認を得て操作を実行するために使用することを強くお勧めします。また、Catalystは関数をコーディングするための安全なインフラストラクチャを提供しますが、Catalyst関数を使用してコーディングしたロジックの結果はお客様のみの責任となります。 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 ##### Browser Grid -------------------------------------------------------------------------------- title: "概要" description: "このページでは、プロジェクト内のすべてのジョブプールを取得するPythonメソッドをサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.364Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/smartbrowz/browser-grid/overview/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Java SDK (/ja/sdk/java/v1/smartbrowz/browser-grid/overview/) - Node.js SDK (/ja/sdk/nodejs/v2/smartbrowz/browser-grid/overview/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # 概要 Browser Gridは、*Catalyst SmartBrowz*サービスのオートスケーリングコンポーネントで、複数のヘッドレスブラウザを構成および管理できます。プロセスに必要なノード数とブラウザ数を構成することで、必要なグリッドを構成するオプションが提供されます。 Browser Grid Python SDKを使用すると、ブラウザグリッドの詳細を取得したり、ブラウザグリッドのノードの詳細を取得したり、ブラウザグリッドの実行を終了したりできます。 ### SDKメソッド一覧 <table class="content-table"> <thead> <tr> <th class="w25p">カテゴリ</th> <th class="w50p">SDKメソッド</th> <th class="w25p">スコープ要件</th> </tr> </thead> <tbody> <tr> <td>一般操作</td> <td>Browser Gridインスタンスの取得</td> <td>Admin</td> </tr> <tr> <td>Browser Grid操作</td> <td> <ul> <li>すべてのブラウザグリッドの取得</li> <li>特定のブラウザグリッドの取得</li> <ul> <li>IDで特定のブラウザグリッドを取得</li> <li>名前で特定のブラウザグリッドを取得</li> </ul> <li>グリッドのノードを取得</li> <ul> <li>Grid IDを使用</li> <li>グリッド名を使用</li> </ul> <li>ブラウザグリッドの停止</li> <ul> <li>Grid IDを使用</li> <li>グリッド名を使用</li> </ul> </ul> </td> <td>Admin</td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "Browser Gridインスタンスの取得" description: "このページでは、プロジェクト内のすべてのジョブプールを取得するPythonメソッドをサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.364Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/smartbrowz/browser-grid/get-instance/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Java SDK (/ja/sdk/java/v1/smartbrowz/browser-grid/get-instance/) - Node.js SDK (/ja/sdk/nodejs/v2/smartbrowz/browser-grid/get-instance/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # Browser Gridインスタンスの取得 以下に示すようにブラウザグリッドインスタンスを取得できます。これはサーバーサイドの呼び出しを実行しません。Browser Gridコンポーネントを使用する際のさまざまなコードスニペットで、このコンポーネントインスタンスを参照します。 grid = app.smart_browz().browser_grid() # Browser Gridインスタンスを取得する -------------------------------------------------------------------------------- title: "すべてのBrowser Gridの詳細を取得" description: "このページでは、プロジェクト内のすべてのジョブプールを取得するPythonメソッドをサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.364Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/smartbrowz/browser-grid/get-all-grids/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Java SDK (/ja/sdk/java/v1/smartbrowz/browser-grid/get-all-grids/) - Node.js SDK (/ja/sdk/nodejs/v2/smartbrowz/browser-grid/get-all-grids/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # すべてのBrowser Gridの詳細を取得 get_all_grid() SDKメソッドを使用して、プロジェクト内に存在するすべてのブラウザグリッドのグリッド詳細を取得できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 情報: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 grid_list = grid.get_all_grid() # すべてのグリッドの詳細を返す print(grid_list) ### 期待されるレスポンスの例 { "status": "success", "data": [ { "id": "3970000000006058", "name": "play", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 07:04 PM", "modified_time": "Sep 10, 2025 07:04 PM", "api_key_modified_time": "1757511270919", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 1, "max_session_count": 1, "max_nodes_count": 10, "max_concurrent_count": 10, "config_type": 1 }, { "id": "3970000000005426", "name": "Automation", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 12:47 PM", "modified_time": "Sep 23, 2025 03:12 PM", "api_key_modified_time": "1757488669690", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 2, "max_session_count": 1, "max_nodes_count": 5, "max_concurrent_count": 5, "config_type": 2 }, { "id": "3970000000005027", "name": "SDK", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 11:33 AM", "modified_time": "Sep 10, 2025 04:27 PM", "api_key_modified_time": "1757484201284", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 2, "max_session_count": 1, "max_nodes_count": 5, "max_concurrent_count": 5, "config_type": 1 }, { "id": "3970000000005015", "name": "Puppeteer_Grid", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 10:21 AM", "modified_time": "Sep 10, 2025 10:21 AM", "api_key_modified_time": "1757479864798", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 1, "max_session_count": 1, "max_nodes_count": 1, "max_concurrent_count": 1, "config_type": 1 }, { "id": "3970000000005013", "name": "Selenium_Gridt", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 10:21 AM", "modified_time": "Sep 23, 2025 05:50 PM", "api_key_modified_time": "1757479864794", "created_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 2, "max_session_count": 1, "max_nodes_count": 1, "max_concurrent_count": 1, "config_type": 2 } ] } -------------------------------------------------------------------------------- title: "特定のBrowser Gridの取得" description: "このページでは、プロジェクト内のすべてのジョブプールを取得するPythonメソッドをサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.364Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/smartbrowz/browser-grid/get-specific-grid/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Java SDK (/ja/sdk/java/v1/smartbrowz/browser-grid/get-specific-grid/) - Node.js SDK (/ja/sdk/nodejs/v2/smartbrowz/browser-grid/get-specific-grid/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # 特定のBrowser Gridの取得 Grid IDまたはグリッド名をgetGrid() SDKメソッドに渡すことで、プロジェクト内の特定のブラウザグリッドの詳細を取得できます。 情報: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 ### Grid IDを使用 必要なブラウザグリッドの**Grid ID**をget_grid() SDKメソッドに渡すことができます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 grid_details = grid.get_grid(3970000000005013) # Grid IDを使用してグリッドの詳細を取得する print(grid_details) ### グリッド名を使用 必要なブラウザグリッドの名前をget_grid() SDKメソッドに渡すことができます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 grid_details = grid.get_grid("Selenium_Grid") # グリッドの名前を使用してグリッドの詳細を取得する print(grid_details) ### 期待されるレスポンスの例 { "status": "success", "data": { "id": "3970000000006058", "name": "Selenium_Grid", "memory": 1024, "browser_version": { "chrome_version": "137.0.7515.155", "firefox_version": "136.0.4" }, "created_time": "Sep 10, 2025 07:04 PM", "modified_time": "Sep 24, 2025 11:55 AM", "api_key_modified_time": "1757511270919", "created_by": { "zuid": "111734674", "is_confirmed": false, "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "modified_by": { "zuid": "111734674", "is_confirmed": false, "email_id": "emmy@zylker.com", "first_name": "Headless", "last_name": "2", "user_type": "SuperAdmin" }, "project_details": { "project_name": "Project-Rainfall", "id": "38119000000022053", "project_type": "Live" }, "endpoint_type": 1, "max_session_count": 1, "max_nodes_count": 10, "max_concurrent_count": 10, "config_type": 1 } } -------------------------------------------------------------------------------- title: "ノードの詳細を取得" description: "このページでは、プロジェクト内のすべてのジョブプールを取得するPythonメソッドをサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.364Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/smartbrowz/browser-grid/get-specific-node/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Java SDK (/ja/sdk/java/v1/smartbrowz/browser-grid/get-specific-node/) - Node.js SDK (/ja/sdk/nodejs/v2/smartbrowz/browser-grid/get-specific-node/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # ノードの詳細を取得 必要なブラウザグリッドの**Grid ID**または名前をget_grid_nodes() SDKメソッドに渡すことで、そのグリッド内のノードの詳細を取得できます。 情報: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 ### Grid IDを使用 必要なブラウザグリッドの**Grid ID**をget_grid_nodes() SDKメソッドに渡して、ノードの詳細を取得できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 node_details = grid.get_grid_nodes(3970000000005013) # Grid IDを使用してノードの詳細を取得する print(node_details) ### グリッド名を使用 必要なブラウザグリッドの名前をget_grid_nodes() SDKメソッドに渡して、ノードの詳細を取得できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 node_details = grid.get_grid_nodes("Selenium_Grid") # グリッドの名前を使用してノードの詳細を取得する print(node_details) -------------------------------------------------------------------------------- title: "Browser Gridの停止" description: "このページでは、プロジェクト内のすべてのジョブプールを取得するPythonメソッドをサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.364Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/smartbrowz/browser-grid/stop-grid/" service: "SmartBrowz" related: - Browser Grid Help Documentation (/ja/smartbrowz/help/browser-grid/introduction/) - Java SDK (/ja/sdk/java/v1/smartbrowz/browser-grid/stop-grid/) - Node.js SDK (/ja/sdk/nodejs/v2/smartbrowz/browser-grid/stop-grid/) - REST API (/ja/smartbrowz/help/browser-grid/introduction/) -------------------------------------------------------------------------------- # Browser Gridの停止 必要なブラウザグリッドの**Grid ID**または名前をstop_grid() SDKメソッドに渡すことで、すべての実行を終了してブラウザグリッドを停止できます。 情報: このSDKメソッドを使用するには、Adminスコープで初期化する必要があります。この要件の詳細については、こちらのセクションを参照してください。 ### Grid IDを使用 必要なブラウザグリッドの**Grid ID**をstop_grid() SDKメソッドに渡して、グリッドを停止し、すべての実行を終了できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 grid_terminate = grid.stop_grid(3970000000005013) # Grid IDを使用してグリッドを停止する ### グリッド名を使用 必要なブラウザグリッドの名前をstop_grid() SDKメソッドに渡して、グリッドを停止し、すべての実行を終了できます。以下のスニペットで使用されているgridインスタンスは、コンポーネントリファレンスです。 grid_terminate = grid.stop_grid("Selenium_Grid") # グリッドの名前を使用してグリッドを停止する ### 期待されるレスポンスの例 { "status": "success", "data": true } #### Zia Services -------------------------------------------------------------------------------- title: "Ziaインスタンスの取得" description: "このページでは、サンプルコードスニペットを使用して、Pythonアプリケーションでバーコードスキャナー機能を使用して特定のデータ形式をスキャンする方法について説明します。" last_updated: "2026-06-10T06:04:54.364Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/get-component-instance/" service: "Zia Services" related: - Catalyst Zia (/ja/zia-services/getting-started/introduction) -------------------------------------------------------------------------------- # Catalyst Zia Catalyst Ziaは、スマートで信頼性の高いアプリケーションを構築するためにすぐに組み込むことができる、フルマネージドのAI/ML搭載コンポーネントのスイートです。これらのコンポーネントは、ビジネスのさまざまな側面で非常に有益なデータの検出、処理、予測を支援します。 ソースコードにコンポーネント固有のSDKスニペットを実装することで、アプリケーションでCatalyst Ziaサービスを使用できます。 # コンポーネントインスタンスの取得 コンポーネントインスタンスは、特定のコンポーネントに固有の定義済み設定にアクセスするために使用できるオブジェクトです。このプロセスはサーバーサイドの呼び出しを発行しません。また、このコンポーネントインスタンスは、アプリケーションでZiaサービスを実装する際のさまざまなシナリオで使用されることに注意してください。 以下のコードで使用されているapp参照は、SDKの初期化時にレスポンスとして返されるPythonオブジェクトです。以下のように新しいziaインスタンスを作成できます： #Ziaコンポーネントインスタンスを取得する zia = app.zia() -------------------------------------------------------------------------------- title: "OCR" description: "このページでは、サンプルコードスニペットを使用して、Pythonアプリケーションで光学文字認識機能を使用してテキスト文字を検出する方法について説明します。" last_updated: "2026-06-10T06:04:54.364Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/ocr/" service: "Zia Services" related: - OCR - API (/ja/api/code-reference/zia-services/ocr/#OCR) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # 光学文字認識 Zia光学文字認識は、画像やデジタルドキュメント内のテキスト文字を電子的に検出し、マシンエンコードされたテキストに変換します。Zia OCRは9つの国際言語と10のインド言語のテキストを認識できます。言語と言語コードのリストは、APIドキュメントで確認できます。 注意:Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたファイルは一度きりの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、該当するすべてのデータ保護およびプライバシー法に完全に準拠しています。 OCR処理が必要な画像またはドキュメントファイルのパスをopen()メソッドのパラメータとして指定する必要があります。これによりファイルが開かれ、レスポンスとしてファイルオブジェクトが返されます。 許可されるファイル形式: ._jpg_、._jpeg_、._png_、._tiff_、._bmp_、._pdf_ ファイルサイズ制限: 20 MB extract_optical_characters()メソッドに、ファイルパス、モデルタイプ、言語を引数として渡す必要があります。ただし、モデルタイプと言語の値はオプションです。デフォルトではOCRモデルタイプとして渡され、言語は指定されない場合は自動的に検出されます。 以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>img</td> <td>Image</td> <td>必須パラメータです。解析対象の画像を格納します。</td> </tr> <tr> <td>language</td> <td>String</td> <td>必須パラメータです。識別対象の言語を格納します。</td> </tr> <tr> <td>modelType</td> <td>String</td> <td>必須パラメータです。デフォルト値として「OCR」を格納します。</td> </tr> </tbody> </table> # OCR Implementation zia = app.zia() img = open("sample.webp", "rb") result = zia.extract_optical_characters(img, {"language": "eng", "modelType": "OCR"}) サンプルレスポンスを以下に示します： { "confidence":95, "text":"This is a lot of 12 point text to test the\nocr code and see if it works on all types\nof file format\n\nThe quick brown dog jumped over the\nlazy fox. The quick brown dog jumped\nover the lazy fox. The quick brown dog\njumped over the lazy fox. The quick\nbrown dog jumped over the lazy fox" } 情報 : 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 -------------------------------------------------------------------------------- title: "顔分析" description: "このページでは、サンプルコードスニペットを使用して、PythonアプリケーションでFace Analytics機能を使用して指定された条件で顔を検出する方法について説明します。" last_updated: "2026-06-10T06:04:54.364Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/face-analytics/" service: "Zia Services" related: - Face Analytics - API (/ja/api/code-reference/zia-services/face-analytics/#FaceAnalytics) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Face Analytics Zia Face Analyticsは、画像内の顔検出を実行し、顔の特徴を分析して、検出された顔の性別、年齢、感情などの情報を提供します。 Face Analyticsを実行するために、.webp/.jpegまたは.pngファイルをopen()メソッドへの入力として提供する必要があります。これにより、指定されたファイルが開かれ、レスポンスとしてファイルオブジェクトが返されます。 analyse_face()メソッドは、入力画像を引数として受け取ります。分析モードをbasic、moderate、またはadvancedとして指定することもできます。また、属性age、smile、またはgenderを検出する場合はtrue、検出しない場合はfalseとして指定できます。これらの値はオプションです。デフォルトでは、すべての属性が検出され、advancedモードが処理されます。 リクエストとレスポンスの形式については、APIドキュメントを参照してください。 以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 レスポンスは、有効化された属性の予測、各顔の顔の特徴の座標とランドマーク、および各分析の信頼度スコアを返します。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>img</td> <td>Image</td> <td>必須パラメータです。分析対象の顔の画像を格納します。</td> </tr> <tr> <td>mode</td> <td>String</td> <td>オプションパラメータです。分析モードの値（「basic」、「moderate」、または「advanced」）を格納します。</td> </tr> <tr> <td>age</td> <td>Boolean</td> <td>オプションパラメータです。年齢を判定するかどうかを決定します。「Yes」または「No」の値を受け付けます。</td> </tr> <tr> <td>emotion</td> <td>Boolean</td> <td>オプションパラメータです。感情を判定するかどうかを決定します。「Yes」または「No」の値を受け付けます。</td> </tr> <tr> <td>gender</td> <td>Boolean</td> <td>オプションパラメータです。性別を判定するかどうかを決定します。「True」または「False」の値を受け付けます。</td> </tr> </tbody> </table> # Face Analytics implementation zia = app.zia() img = open("sample.webp", "rb") result = zia.analyse_face( img, {"mode": "moderate", "age": True, "emotion": True, "gender": False} ) サンプルレスポンスを以下に示します： { "faces_count":1, "faces":[ { "co_ordinates":[ "401", "193", "494", "313" ], "emotion":{ "confidence":{ "smiling":"0.75", "not_smiling":"0.25" }, "prediction":"smiling" }, "gender":{ }, "confidence":1, "id":"0", "landmarks":{ "right_eye":[ [ "467", "230" ] ], "nose":[ [ "451", "264" ] ], "mouth_right":[ [ "474", "278" ] ], "left_eye":[ [ "426", "239" ] ], "mouth_left":[ [ "434", "283" ] ] }, "age":{ "confidence":{ "20-29":"0.73", "30-39":"0.08", "0-2":"0.0", "40-49":"0.0", "50-59":"0.0", ">70":"0.0", "60-69":"0.0", "10-19":"0.17", "3-9":"0.0" }, "prediction":"20-29" } } ] } 情報 : 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 -------------------------------------------------------------------------------- title: "画像モデレーション" description: "このページでは、サンプルコードスニペットを使用して、PythonアプリケーションでImage Moderation機能を使用して画像内の脆弱性を検出する方法について説明します。" last_updated: "2026-06-10T06:04:54.365Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/image-moderation/" service: "Zia Services" related: - Image Moderation - API (/ja/api/code-reference/zia-services/image-moderation/#ImageModeration) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Image Moderation Image Moderationは、画像内の不適切で安全でないコンテンツを検出・認識します。基準には、示唆的または明示的なわいせつコンテンツ、ヌード、暴力、残虐行為、流血、武器や薬物の存在が含まれます。 open()メソッドに.webp/.jpegまたは.pngファイルを入力として提供できます。このメソッドは、レスポンスとして画像ファイルオブジェクトを返します。 モデレーションモードとしてBASIC、MODERATE、またはADVANCEDをオプションで設定できます。デフォルトでは画像はADVANCEDモードで処理されます。 レスポンスは、各基準の確率と信頼度スコア、および画像がsafe_to_useまたはunsafe_to_useであるかの予測を返します。 以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>img</td> <td>Image</td> <td>必須パラメータです。分析対象の画像を格納します。</td> </tr> <tr> <td>options</td> <td>Array</td> <td>オプションパラメータです。分析モードの値（「basic」、「moderate」、または「advanced」）を格納します。</td> </tr> </tbody> </table> zia = app.zia() img = open("sample.webp", "rb") result = zia.moderate_image(img, options={"mode": "moderate"}) サンプルレスポンスを以下に示します： { "probability":{ "racy":"0.09", "nudity":"0.06" }, "confidence":"0.85", "prediction":"safe_to_use" } 情報 : 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 -------------------------------------------------------------------------------- title: "物体認識" description: "このページでは、サンプルコードスニペットを使用して、PythonアプリケーションでObject Recognition機能を使用してオブジェクトを検出する方法について説明します。" last_updated: "2026-06-10T06:04:54.365Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/object-recognition/" service: "Zia Services" related: - Object Recognition - API (/ja/api/code-reference/zia-services/object-recognition/#ObjectRecognition) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Object Recognition Object Recognitionは、画像ファイル内の個々のオブジェクトを検出、特定、認識します。Zia Object Recognitionは画像から80種類のオブジェクトを識別できます。 open()メソッドに.webp/.jpegまたは.pngファイルを入力として提供できます。このメソッドは、レスポンスとして画像ファイルオブジェクトを返します。リクエストとレスポンスの形式については、APIドキュメントを参照してください。 detect_object()メソッドは、画像内のオブジェクトを検出・識別するために使用され、入力ファイルがこのメソッドの引数として渡されます。各オブジェクトの座標、種類、および各認識の信頼度スコアを返します。 以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>img</td> <td>Image</td> <td>必須パラメータです。オブジェクト解析対象の画像を格納します。</td> </tr> </tbody> </table> zia = app.zia() img = open("sample.webp", "rb") result = zia.detect_object(img) サンプルレスポンスを以下に示します： { "objects":[ { "co_ordinates":[ "322", "125", "708", "1201" ], "object_type":"person", "confidence":"99.82" } ] } 情報 : 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 -------------------------------------------------------------------------------- title: "バーコードスキャナー" description: "このページでは、サンプルコードスニペットを使用して、PythonアプリケーションでBarcode Scanner機能を使用して特定のデータ形式をスキャンする方法について説明します。" last_updated: "2026-06-10T06:04:54.365Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/barcode-scanner/" service: "Zia Services" related: - Barcode Scanner - API (/ja/api/code-reference/zia-services/barcode-scanner/#BarcodeScanner) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Barcode Scanner Zia Barcode Scannerは、最も一般的に使用されるリニアおよび2Dバーコード形式をスキャンし、エンコードされたデータをデコードすることを可能にします。Barcode Scannerは、Codabar、EAN-13、ITF、UPC-A、QR Codeなどの形式を検出できます。 open()メソッドに.webp/.jpegまたは.png形式の入力ファイルを提供できます。このメソッドは、レスポンスとして画像ファイルオブジェクトを返します。リクエストとレスポンスの形式については、APIドキュメントを参照してください。 setFormatを使用してバーコード形式を指定できます。形式としてALLを入力すると、Barcode Scannerが自動的に形式を検出します。デコードされた情報がレスポンスとして提供されます。 以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>img</td> <td>Image</td> <td>必須パラメータです。トレーニングするモデルのIDを格納します。</td> </tr> <tr> <td>options</td> <td>Array</td> <td>必須パラメータです。バーコードの形式を格納します。</td> </tr> </tbody> </table> zia = app.zia() img = open("sample.webp", "rb") result = zia.scan_barcode(img, options={"format": "code39"}) サンプルレスポンスを以下に示します： { "content":"https://demo.dynamsoft.com/dbr_wasm/barcode_reader_javascript.html" } 情報 : 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 ##### ID スキャナー -------------------------------------------------------------------------------- title: "顔比較" description: "このページでは、Pythonアプリケーションで顔比較機能を使用する方法をサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.365Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/identity-scanner/facial-comparison/" service: "Zia Services" related: - Facial Comparison - API (/ja/api/code-reference/zia-services/identity-scanner/facial-comparison/#FacialComparison) - Facial Comparison Help (/ja/zia-services/help/identity-scanner/key-concepts/#facial-comparison-process) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、Zia AIを活用したコンポーネントで、さまざまなID証明書や公的文書をスキャンして処理することで、個人や文書に対する安全な本人確認を行うことができます。E-KYCとドキュメント処理の2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注意: Catalystはアップロードされたファイルをシステムに保存しません。アップロードされた文書は1回限りの処理にのみ使用されます。MLモデルのトレーニング目的には使用されません。Catalystのコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。 ### 顔比較 顔比較（E-KYCとも呼ばれます）は、Identity Scannerの一部で、2つの異なる画像内の2つの顔を比較して、同一人物であるかどうかを判定します。これにより、既存の写真とID証明書を比較して個人の身元を確認できます。たとえば、個人のAadhaarカードなどの写真付きIDを、その人の現在の写真と比較して真正性を確認できます。 注意: Identity Scannerのドキュメント処理機能はインドのユーザーのみに関連しますが、顔比較APIおよびSDKツールはグローバルに利用可能です。ただし、CatalystコンソールからのFacial ComparisonまたはE-KYCへのアクセスおよびテストは、IN DCのユーザーのみに制限されています。 サンプルコードに示すように、ソース画像とクエリ画像の両方の画像ファイルのパスを指定して、顔比較を実行できます。compare_face()メソッドは、これらの両方の画像を処理します。以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 注意: ID証明書の画像または個人の写真のいずれかをソースまたはクエリ画像として指定できます。これは結果に影響しません。 許可されるファイル形式: _.webp_、_.jpeg_、_.png_ ファイルサイズ制限: 10 MB 比較の結果は、顔が一致する場合はtrueに設定され、一致しない場合はfalseに設定されます。結果には、処理の精度を示す0から1の範囲の信頼度スコアも含まれます。比較の信頼度スコアが50%（つまり0.5）を超えた場合にのみ、結果がtrueに設定されます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>img</td> <td>Image</td> <td>必須パラメータ。顔の最初の画像ファイルを格納します。</td> </tr> <tr> <td>img2</td> <td>Image</td> <td>必須パラメータ。顔の2番目の画像ファイルを格納します。</td> </tr> </tbody> </table> # Facial Comparison feature implementation zia = app.zia() img = open("sample1.webp", "rb") img2 = open("sample2.webp", "rb") result = zia.compare_face(img, img2) サンプルレスポンスを以下に示します： { "confidence":0.9464, "matched":"true" } 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "Aadhaar" description: "このページでは、サンプルコードスニペットを使用して、PythonアプリケーションでAADHAARドキュメント処理機能を使用する方法について説明します。" last_updated: "2026-06-10T06:04:54.365Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/identity-scanner/aadhaar/" service: "Zia Services" related: - Aadhaar - API (/ja/api/code-reference/zia-services/identity-scanner/aadhaar/#Aadhaar) - Aadhaar Help (/ja/zia-services/help/identity-scanner/key-concepts/#model-types) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、さまざまなIDプルーフや公式ドキュメントをスキャン・処理することで、個人とドキュメントの安全な身元確認を実行できるZia AI駆動コンポーネントです。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注意: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一度きりの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、該当するすべてのデータ保護およびプライバシー法に完全に準拠しています。 ## Aadhaar AADHAARモデルは、インドのAadhaarカードを身分証明ドキュメントとして処理するDocument Processing機能の一部です。高度なOCR技術を使用して、インドのAadhaarカードからデータフィールドを抽出できます。レスポンスは、Aadhaarカードから認識されたパラメータと、精度を判定する各認識の信頼度スコアを返します。 注意:Document Processingはインドのユーザーにのみ関連しており、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SA、またはCAデータセンターからアクセスするユーザーには利用できません。インド以外の他のDCのユーザーは、テキストコンテンツの読み取りと処理に一般的なOCRコンポーネントを使用できます。 以下のコードに示すように、Aadhaarカードの表面と裏面の画像ファイルのパスをopen()メソッドに提供する必要があります。これにより両方のファイルが開かれ、レスポンスとしてそれぞれのファイルオブジェクトが返されます。以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 Identity Scannerは、Aadhaarカード内の言語を自動的に識別して処理するようになりました。以下のコードに示すように、一時的に言語を渡すことができます。英語と関連する地域言語を渡す必要があります。たとえば、タミル・ナードゥ州出身の場合は、言語としてtamとengを渡す必要があります。言語と言語コードのリストは、APIドキュメントで確認できます。 許可されるファイル形式: _.webp_、_.jpeg_、_.png_、_.bmp_、_.tiff_、_.pdf_<br /> ファイルサイズ制限: 15 MB レスポンスには、カード保有者の名前、住所、性別、それぞれのキーに割り当てられたAadhaarカード番号など、Aadhaarカードで認識されたパラメータが含まれます。レスポンスには、認識された各値に対する0から1の範囲の信頼度スコアも表示されます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>aadhar_front</td> <td>Image</td> <td>必須パラメータです。15 MB以下のAadhaar表面画像を格納します。</td> </tr> <tr> <td>aadhar_back</td> <td>Image</td> <td>必須パラメータです。15 MB以下のAadhaar裏面画像を格納します。</td> </tr> <tr> <td>language</td> <td>String</td> <td>必須パラメータです。識別対象の言語を格納します。</td> </tr> </tbody> </table> zia = app.zia() img = open("sample.webp", "rb") img2 = open("sample2.webp", "rb") result = zia.extract_aadhaar_characters(img, img2, language="eng,tam") サンプルレスポンスを以下に示します： { "text":{ "address":{ "prob":0.5, "value":"C/O Rainbow, xxxx STREET, xxxx- 0000" }, "gender":{ "prob":0.8, "value":"MALE" }, "dob":{ "prob":0.8, "value":"08/09/2001" }, "name":{ "prob":0.6, "value":"Ram Singh" }, "aadhaar":{ "prob":0.8, "value":"4000 0000 0000" } } } 情報 : 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 -------------------------------------------------------------------------------- title: "PAN" description: "このページでは、サンプルコードスニペットを使用して、PythonアプリケーションでPANドキュメント処理機能を使用する方法について説明します。" last_updated: "2026-06-10T06:04:54.365Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/identity-scanner/pan/" service: "Zia Services" related: - PAN - API (/ja/api/code-reference/zia-services/identity-scanner/pan/#PAN) - PAN Help (/ja/zia-services/help/identity-scanner/key-concepts/#model-types) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、さまざまなIDプルーフや公式ドキュメントをスキャン・処理することで、個人とドキュメントの安全な身元確認を実行できるZia AI駆動コンポーネントです。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注意: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一度きりの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、該当するすべてのデータ保護およびプライバシー法に完全に準拠しています。 #### PAN PANモデルは、インドのPANカードを身分証明ドキュメントとして処理するDocument Processing機能の一部です。高度なOCR技術を使用してPANカードからデータフィールドを抽出し、レスポンスでPANカードから認識されたパラメータを返します。 注意:Document Processingはインドのユーザーにのみ関連しており、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SA、またはCA DCからアクセスするユーザーには利用できません。インド以外の他のDCのユーザーは、テキストコンテンツの読み取りと処理に一般的なOCRコンポーネントを使用できます。 以下のコードに示すように、PANカードの表面の画像ファイルのパスをopen()メソッドに提供する必要があります。このメソッドはファイルを開き、レスポンスとしてファイルオブジェクトを返します。 以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 許可されるファイル形式: _.webp_、_.jpeg_、_.png_<br /> ファイルサイズ制限: 15 MB modelTypeを使用してモデルタイプをPANとして指定する必要があります。PANモデルは、デフォルトで英語のテキストのみを処理できます。他の言語はサポートされていません。 レスポンスには、姓、名、生年月日、およびそれぞれのキーに割り当てられたPANカード番号など、PANカードから抽出されたパラメータが含まれます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>img</td> <td>Image</td> <td>必須パラメータです。PANカードの表面の画像ファイルを格納します。</td> </tr> <tr> <td>modelType</td> <td>String</td> <td>必須パラメータです。デフォルト値として「PAN」を格納します。</td> </tr> </tbody> </table> zia = app.zia() img = open("sample.webp", "rb") result = zia.extract_optical_characters(img, {"modelType": "PAN"}) レスポンスを以下に示します： { "date_of_birth":"03/04/1982", "last_name":"VASUDEV MAHTO", "pan":"ANRPM2537J", "first_name":"PRAMOD KUMAR MAHTO" } 情報 : 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 -------------------------------------------------------------------------------- title: "通帳" description: "このページでは、サンプルコードスニペットを使用して、PythonアプリケーションでPASSBOOKドキュメント処理機能を使用する方法について説明します。" last_updated: "2026-06-10T06:04:54.365Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/identity-scanner/passbook/" service: "Zia Services" related: - Passbook - API (/ja/api/code-reference/zia-services/identity-scanner/passbook/#Passbook) - Passbook Help (/ja/zia-services/help/identity-scanner/key-concepts/#model-types) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、さまざまなIDプルーフや公式ドキュメントをスキャン・処理することで、個人とドキュメントの安全な身元確認を実行できるZia AI駆動コンポーネントです。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注意: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一度きりの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、該当するすべてのデータ保護およびプライバシー法に完全に準拠しています。 #### Passbook PASSBOOKモデルは、インドの銀行通帳を金融または身分証明ドキュメントとして処理するDocument Processing機能の一部です。OCR技術を使用して通帳からデータフィールドを抽出し、レスポンスでパラメータを取得できます。 注意: Document Processingはインドのユーザーにのみ関連しており、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SA、またはCAデータセンターからアクセスするユーザーには利用できません。インド以外の他のDCのユーザーは、テキストコンテンツの読み取りと処理に一般的なOCRコンポーネントを使用できます。 Passbookモデルは11のインド言語と追加の8つの国際言語をサポートしています。言語と言語コードのリストは、APIドキュメントで確認できます。 以下のコードに示すように、通帳の表ページの画像のパスを提供する必要があります。 許可されるファイル形式: _.webp_、_.jpeg_、_.png_、_.bmp_、_.tiff_、_.pdf_<br /> ファイルサイズ制限: 15 MB キーmodelTypeを使用してモデルタイプをPASSBOOKとして指定する必要があります。 以下のコードに示すように、オプションで言語を指定することもできます。指定しない場合は、デフォルトの言語として英語が使用されます。 レスポンスには、銀行名、支店、住所、口座番号など、通帳から認識された銀行の詳細と口座の詳細が含まれます。抽出された情報フィールドは、それぞれのキーに割り当てられます。レスポンスには、その口座でRTGS、NEFT、IMPSが有効になっているかどうかも表示されます。 注意: Identity Scannerは、通帳に含まれる言語に関係なく、レスポンスを英語でのみ返します。 以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>img</td> <td>Image</td> <td>必須パラメータです。検出対象の言語を格納します。</td> </tr> <tr> <td>modelType</td> <td>String</td> <td>必須パラメータです。デフォルト値として「PASSBOOK」を格納します。</td> </tr> </tbody> </table> zia = app.zia() img = open("sample.webp", "rb") result = zia.extract_optical_characters( img, {"language": "tam", "modelType": "PASSBOOK"} ) サンプルレスポンスを以下に示します： { "text":{ "address":"No.20,Gandhi Road,M.G Lane", "city":"Chennai", "centre":"Chennai", "bankName":"ABX BANK LIMITED", "accountNumber":"002001001625859", "branch":"Anna Nagar", "dateOfOpening":"30/08/2012", "imps":"true", "neft":"true", "district":"Chennai", "contact":"801234567", "micr":"641021121", "name":" 2312312", "state":"Tamil Nadu", "rtgs":"true", "ifsc":"ABX0000311" } } 情報 : 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 -------------------------------------------------------------------------------- title: "小切手" description: "このページでは、サンプルコードスニペットを使用して、PythonアプリケーションでChequeドキュメント処理機能を使用する方法について説明します。" last_updated: "2026-06-10T06:04:54.365Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/identity-scanner/cheque/" service: "Zia Services" related: - Cheque - API (/ja/api/code-reference/zia-services/identity-scanner/cheque/#Cheque) - Cheque Help (/ja/zia-services/help/identity-scanner/key-concepts/#model-types) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # Identity Scanner Identity Scannerは、さまざまなIDプルーフや公式ドキュメントをスキャン・処理することで、個人とドキュメントの安全な身元確認を実行できるZia AI駆動コンポーネントです。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。 注意: Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされたドキュメントは一度きりの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、該当するすべてのデータ保護およびプライバシー法に完全に準拠しています。 #### Cheque CHEQUEモデルは、インドの銀行小切手を身分証明ドキュメントとして処理するDocument Processing機能の一部です。高度なOCR技術を使用して小切手からデータフィールドを抽出し、レスポンスを通じて小切手から認識されたパラメータを取得できます。 注意: Document Processingはインドのユーザーにのみ関連しており、IN DCでのみ利用可能です。この機能は、EU、AU、JP、SA、US、またはCA DCからアクセスするユーザーには利用できません。インド以外の他のDCのユーザーは、テキストコンテンツの読み取りと処理に一般的なOCRコンポーネントを使用できます。 以下のコードに示すように、小切手帳の表ページの画像ファイルのパスをopen()メソッドに提供する必要があります。このメソッドは、レスポンスとしてファイルオブジェクトを返します。 CHEQUEモデルは、デフォルトで英語のテキストのみを処理できます。他の言語はサポートされていません。 許可されるファイル形式: _.webp_、_.jpeg_、_.png_<br /> ファイルサイズ制限: 15 MB modelType()を使用してモデルタイプをCHEQUEとして指定する必要があります。 注意:ZiaはCTS-2010形式の小切手のみを処理します。 以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>img</td> <td>Image</td> <td>必須パラメータです。小切手帳の表ページの画像ファイルを格納します。</td> </tr> <tr> <td>modelType</td> <td>String</td> <td>必須パラメータです。デフォルト値として「CHEQUE」を格納します。</td> </tr> </tbody> </table> zia = app.zia() img = open('sample.webp', 'rb') result = zia.extract_optical_characters(img, {'modelType': 'CHEQUE'}) サンプルレスポンスを以下に示します： { "date":"15/11/2014", "account_number":"89323223232222", "amount":"10615", "branch_name":"ANNA NAGAR", "bank_name":"ABX BANK", "ifsc":"BB9033232" } 情報 : 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープテーブルを参照してください。 ##### テキスト解析 -------------------------------------------------------------------------------- title: "感情分析" description: "このページでは、Pythonアプリケーションで感情分析機能を使用する方法をサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.366Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/text-analytics/sentiment-analysis/" service: "Zia Services" related: - Sentiment Analysis - API (/ja/api/code-reference/zia-services/text-analytics/sentiment-analysis/#SentimentAnalysis) - Sentiment Analysis Help (/ja/zia-services/help/text-analytics/key-concepts/#sentiment-analysis) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # 感情分析 Zia感情分析は、テキスト分析の一部で、テキストコンテンツを処理してメッセージのトーンとそれを通じて伝えられる感情を認識します。テキスト内の各文を分析し、そのトーンがポジティブ、ネガティブ、またはニュートラルであるかを判定します。次に、各文で認識された感情に基づいて、テキスト全体のトーンをこれら3つの感情のいずれかとして判定します。 レスポンスには、各文で検出された感情の信頼度スコアも返され、分析の精度を示します。信頼度スコアは0から1の範囲にあります。全体的な分析の信頼度スコアも返されます。 1回のリクエストで最大1500文字のテキストブロックを入力として渡すことができます。入力テキストはget_sentiment_analysis()に渡されます。 テキストのオプションのキーワードを渡すこともできます。これにより、感情分析はこれらのキーワードを含む文のみを処理し、それらの感情を判定します。他の文は無視されます。このメソッドは、2番目のパラメータとして空のリストを受け取ります。 以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>text</td> <td>String</td> <td>必須パラメータ。分析するテキストを格納します。</td> </tr> <tr> <td>keyword</td> <td>String</td> <td>オプションパラメータ。キーワードを含む文をフィルタリングして感情を分析するためのキーワードを格納します。</td> </tr> </tbody> </table> zia = app.zia() result = zia.get_sentiment_analysis( [ "Zoho Corporation, is an Indian multinational technology company that makes web-based business tools. It is best known for Zoho Office Suite. The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton, California.","Zoho"], [], ) サンプルレスポンスを以下に示します： { "sentiment_prediction":[ { "document_sentiment":"Neutral", "sentence_analytics":[ { "sentence":"Zoho Corporation, is an Indian multinational technology company that makes web-based business tools.", "sentiment":"Neutral", "confidence_scores":{ "negative":0, "neutral":1, "positive":0 } }, { "sentence":"It is best known for Zoho Office Suite.", "sentiment":"Neutral", "confidence_scores":{ "negative":0, "neutral":0.6, "positive":0.4 } } ], "overall_score":0.83 } ] } 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "固有表現認識" description: "このページでは、Pythonアプリケーションで固有表現認識機能を使用する方法をサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.366Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/text-analytics/named-entity-recognition/" service: "Zia Services" related: - Named Entity Recognition Help (/ja/zia-services/help/text-analytics/key-concepts/#named-entity-recognition) - Named Entity Recognition - API (/ja/api/code-reference/zia-services/text-analytics/named-entity-recognition/#NamedEntityRecognition) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # 固有表現認識 Zia固有表現認識は、テキスト分析の一部で、テキストコンテンツを処理してキーワードを抽出し、さまざまなカテゴリに分類します。たとえば、テキスト内の単語が組織名、人名、または日付であることを判定し、適切なカテゴリに追加します。NERが認識するすべてのカテゴリの一覧については、こちらを参照してください。 レスポンスには、テキスト内で認識されたすべてのエンティティの配列と、それらが属するカテゴリを示すタグが返されます。また、各分類の精度を示す信頼度スコアもパーセンテージ値で含まれます。レスポンスには、テキスト内のエンティティの位置が開始インデックスと終了インデックスを通じて返されます。 以下に示すように、1回のリクエストで最大1500文字のテキストブロックを入力として渡すことができます。テキストはget_NER_prediction()に渡されます。 以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>text</td> <td>String</td> <td>必須パラメータ。エンティティを認識するテキストを格納します。</td> </tr> </tbody> </table> zia = app.zia() result = zia.get_NER_prediction( [ "Zoho Corporation, is an Indian multinational technology company that makes web-based business tools. It is best known for Zoho Office Suite. The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton, California." ] ) サンプルレスポンスを以下に示します： { "ner":{ "general_entities":[ { "start_index":0, "confidence_score":98, "end_index":16, "ner_tag":"Organization", "token":"Zoho Corporation" }, { "start_index":24, "confidence_score":99, "end_index":30, "ner_tag":"Miscellaneous", "token":"Indian" }, { "start_index":122, "confidence_score":90, "end_index":139, "ner_tag":"Miscellaneous", "token":"Zoho Office Suite" }, { "start_index":168, "confidence_score":99, "end_index":181, "ner_tag":"Person", "token":"Sridhar Vembu" }, { "start_index":186, "confidence_score":96, "end_index":197, "ner_tag":"Person", "token":"Tony Thomas" }, { "start_index":220, "confidence_score":100, "end_index":225, "ner_tag":"Number", "token":"seven" }, { "start_index":268, "confidence_score":99, "end_index":275, "ner_tag":"City", "token":"Chennai" }, { "start_index":277, "confidence_score":98, "end_index":282, "ner_tag":"Country", "token":"India" }, { "start_index":314, "confidence_score":99, "end_index":324, "ner_tag":"City", "token":"Pleasanton" }, { "start_index":326, "confidence_score":91, "end_index":336, "ner_tag":"State", "token":"California" } ] } } 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "キーワード抽出" description: "このページでは、Pythonアプリケーションでキーワード抽出機能を使用する方法をサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.366Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/text-analytics/keyword-extraction/" service: "Zia Services" related: - Keyword Extraction Help (/ja/zia-services/help/text-analytics/key-concepts/#keyword-extraction) - Keyword Extraction - API (/ja/api/code-reference/zia-services/text-analytics/keyword-extraction/#KeywordExtraction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # キーワード抽出 Ziaキーワード抽出は、テキスト分析の一部で、テキストコンテンツを処理してテキストのハイライトを抽出します。抽出された用語は、Keywordsと Keyphrasesの2つのカテゴリに分類されます。これらのハイライトは、テキストの簡潔な要約を提供し、テキスト全体の抽象化を行います。 レスポンスには、テキストから抽出されたキーワードの配列と、キーフレーズの配列が含まれます。 以下に示すように、1回のリクエストで最大1500文字のテキストブロックを入力として渡すことができます。テキストはget_keyword_extraction()に渡されます。キーワードとキーフレーズは、個別のリストとして取得されます。 以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>text</td> <td>String</td> <td>必須パラメータ。キーワードを抽出するテキストを格納します。</td> </tr> </tbody> </table> zia = app.zia() result = zia.get_keyword_extraction( [ "Zoho Corporation, is an Indian multinational technology company that makes web-based business tools. It is best known for Zoho Office Suite. The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton, California." ] ) サンプルレスポンスを以下に示します： { "keyword_extractor":{ "keywords":[ "Chennai", "company", "India", "Indian", "presence", "locations", "Pleasanton", "California" ], "keyphrases":[ "corporate headquarters", "multinational technology company", "Zoho Corporation", "Zoho Office Suite", "global headquarters", "Tony Thomas", "web-based business tools", "Sridhar Vembu" ] } } 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 -------------------------------------------------------------------------------- title: "すべてのテキスト分析" description: "このページでは、Pythonアプリケーションでテキスト分析機能を使用する方法をサンプルコードスニペットと共に説明します。" last_updated: "2026-06-10T06:04:54.366Z" source: "https://docs.catalyst.zoho.com/ja/sdk/python/v1/zia-services/text-analytics/all-text-analytics/" service: "Zia Services" related: - All Text Analytics - API (/ja/api/code-reference/zia-services/text-analytics/all-text-analytics/#AllTextAnalytics) - All Text Analytics Help (/ja/zia-services/help/text-analytics/introduction) - SDK Scopes (/ja/sdk/python/v1/sdk-scopes) -------------------------------------------------------------------------------- # すべてのテキスト分析 テキスト分析全体として、前のセクションで説明した3つの機能の組み合わせが含まれます：感情分析、固有表現認識、およびキーワード抽出です。特定のテキストブロックに対してこれら3つのアクションすべてを実行し、テキストのトーン、認識されたエンティティの分類、およびテキストの要旨を提供するキーワードやフレーズを取得できます。 以下に示すように、1回のリクエストで最大1500文字のテキストブロックを入力として渡すことができます。テキストはget_text_analytics()に渡されます。また、オプションのキーワードを渡して、それらのキーワードを含む文のみに対して感情分析を実行することもできます。このメソッドは、2番目のパラメータとして空のリストを受け取ります。 レスポンスには、各テキスト分析機能の結果が含まれます。それぞれの機能の詳細については、各機能ページを参照してください。 以下で使用されているコンポーネントインスタンスziaの詳細については、こちらのヘルプセクションを参照してください。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>text</td> <td>String</td> <td>必須パラメータ。分析するテキストを格納します。</td> </tr> </tbody> </table> zia = app.zia() result = zia.get_text_analytics( [ "Zoho Corporation, is an Indian multinational technology company that makes web-based business tools. It is best known for Zoho Office Suite. The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton, California.","Zoho"], [] ) サンプルレスポンスを以下に示します： [ { "keyword_extractor":{ "keywords":[ "Chennai", "company", "India", "Indian", "presence", "locations", "Pleasanton", "California" ], "keyphrases":[ "corporate headquarters", "multinational technology company", "Zoho Corporation", "Zoho Office Suite", "global headquarters", "Tony Thomas", "web-based business tools", "Sridhar Vembu" ] }, "sentiment_prediction":[ { "document_sentiment":"Neutral", "sentence_analytics":[ { "sentence":"Zoho Corporation, is an Indian multinational technology company that makes web-based business tools.", "sentiment":"Neutral", "confidence_scores":{ "negative":0, "neutral":1, "positive":0 } }, { "sentence":"It is best known for Zoho Office Suite.", "sentiment":"Neutral", "confidence_scores":{ "negative":0, "neutral":0.6, "positive":0.4 } }, { "sentence":"The company was founded by Sridhar Vembu and Tony Thomas and has a presence in seven locations with its global headquarters in Chennai, India, and corporate headquarters in Pleasanton, California.", "sentiment":"Neutral", "confidence_scores":{ "negative":0, "neutral":0.88, "positive":0.12 } } ], "overall_score":0.83 } ], "ner":{ "general_entities":[ { "start_index":0, "confidence_score":98, "end_index":16, "ner_tag":"Organization", "token":"Zoho Corporation" }, { "start_index":24, "confidence_score":99, "end_index":30, "ner_tag":"Miscellaneous", "token":"Indian" }, { "start_index":122, "confidence_score":90, "end_index":139, "ner_tag":"Miscellaneous", "token":"Zoho Office Suite" }, { "start_index":168, "confidence_score":99, "end_index":181, "ner_tag":"Person", "token":"Sridhar Vembu" }, { "start_index":186, "confidence_score":96, "end_index":197, "ner_tag":"Person", "token":"Tony Thomas" }, { "start_index":220, "confidence_score":100, "end_index":225, "ner_tag":"Number", "token":"seven" }, { "start_index":268, "confidence_score":99, "end_index":275, "ner_tag":"City", "token":"Chennai" }, { "start_index":277, "confidence_score":98, "end_index":282, "ner_tag":"Country", "token":"India" }, { "start_index":314, "confidence_score":99, "end_index":324, "ner_tag":"City", "token":"Pleasanton" }, { "start_index":326, "confidence_score":91, "end_index":336, "ner_tag":"State", "token":"California" } ] } } ] 情報： 上記の操作を実行するために必要な権限レベルを確認するには、SDKスコープの表を参照してください。 ## Web ### v4 -------------------------------------------------------------------------------- title: "概要" description: "Catalyst Web SDKは、Catalystコンポーネントにアクセスし、Webクライアントアプリケーションを作成するためのツールとライブラリのセットです" last_updated: "2026-06-10T06:04:54.367Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/overview/" service: "All Services" related: - Overview - Node.js SDK (/ja/sdk/nodejs/v2/overview/) - Overview - Java SDK (/ja/sdk/java/v1/overview/) - Overview - Python SDK (/ja/sdk/python/v1/overview/) -------------------------------------------------------------------------------- # Web SDK ## 概要 Catalyst Web SDKには、クライアントWebアプリケーションからCatalystコンポーネントにアクセスするためのJavaScriptメソッドが含まれています。 ### 前提条件 * Catalyst CLI（CLIのインストールを参照） * Catalystプロジェクト（Catalystプロジェクトを参照） * 任意のテキストエディタ（XcodeまたはSublime） ### 認証 Catalystは、Catalyst REST APIおよびSDKにアクセスするための簡単な認証メカニズムを提供しています。クライアントアプリケーションからCatalystコンポーネントを使用するには、Catalystが提供する認証メカニズムを統合することが必須です。 <br> ### SDKの初期化 以下のコードスニペットをアプリケーションに含めることで、Catalyst認証をアプリケーションに統合できます。このスクリプトにより、Catalyst Web SDKのJavaScriptメソッドにアクセスできるようになります。 これにより、Web SDKが初期化され、init.jsファイルが参照されます。このファイルは、プロジェクトの一意のIDであるProject IDや、プロジェクトのキーであるZAIDなど、プロジェクトの基本情報を自動的に設定します。 Note: リクエストパターン/\_\_catalyst/ \*は予約されています。この場所に独自のファイルを配置することはできません。 これらの値は、作業中の環境に基づいて自動的に設定されます。つまり、このスクリプトがアプリの開発環境URLから呼び出された場合、適切なZAID値が設定されます。 &lt;script src="https://static.zohocdn.com/catalyst/sdk/js/4.0.0/catalystWebSDK.js"&gt;&lt;/script&gt; &lt;script src="/__catalyst/sdk/init.js"&gt;&lt;/script&gt; &lt;script&gt; catalyst.auth.signIn("your element id here...."); &lt;/script&gt; このコードスニペットを使用して、アプリケーションのサインインフォームをiFrameとして構築できます。ただし、このコードスニペットをすべてのページに追加する必要があります。catalystオブジェクトのスコープは単一ページに限定されているため、この初期化スクリプトはすべてのページで必要です。 コードにはcatalyst.auth.signIn("Your elementID here");という行が含まれています。elementIDは、アプリケーションのログインページ内の任意のHTML要素またはdiv要素のIDを指定できます。これをアプリケーションのelementIDに置き換え、ユーザーログインを含むページに実装してください。 同じページ内でiFrame用のdivisionを次のように作成できます：_&lt;div id="Your elementID here"&gt; &lt;/div&gt;_。これにより、同じページ内にユーザーログイン用のiFrameが展開されます。 たとえば、elementIDが「login」の場合、コードは次のようになります： * Web SDK初期化スクリプト内：_catalyst.auth.signIn("login");_ * ページのbody内：_&lt;div id="login"&gt;&lt;/div&gt;_ Note: AuthenticationのEmbedded Authenticationセクションから、Web初期化スクリプトの旧バージョン（v 1.0.0）にもアクセスできます。詳細については、Embedded Authenticationヘルプページを参照してください。 <br> ### 環境変数の管理 以下のCatalystメソッドを使用して、コードから環境変数を管理できます： * 環境変数をsetする場合： catalyst.setCatalystEnv(keyName,value) * 環境変数をgetする場合： catalyst.getCatalystEnv(key) * 環境変数をdeleteする場合： catalyst.deleteCatalystEnv(key) <br> ### インスタンスオブジェクト 不要な場合にAPIアクセスを最小限に抑えることは常に効果的です。実際にAPIを呼び出すのではなく、コード内でコンポーネントを参照し、後続のアクセスに使用するためのAPI参照が必要な場合、Catalyst WebSDKはその機能を提供します。 たとえば、以下のコードは特定のファイルコンポーネントを参照する際にAPI呼び出しを実行しません。 catalyst.file.folderId(folder_id).fileId(file_id); ただし、以下のコードは選択したフォルダからファイルを削除するためにAPI呼び出しを実際に実行します。 catalyst.file.folderId(folder_id).fileId(file_id).delete(); Note: 実際のAPI呼び出しの後に、指定されたオブジェクトとともにPromiseが返されます。そのため、.then()は実際のAPI呼び出しの後にのみ処理されます。API呼び出しを実行しないダミーオブジェクトでは、API呼び出しを使用できません。 <br> ### レスポンスと例外 すべてのレスポンスは、データ、ステータスコード、およびステータスメッセージを含むJSONオブジェクトとして返されます。開発者はこれらのオブジェクトからレスポンスを簡単に追跡できます。 #### 例外 アプリケーション出力の不正な動作は、例外またはエラーと呼ばれます。Catalyst Web SDKは、appET, ServerET,および DeveloperET.と呼ばれる3種類のエラーをスローします。これらのエラーは、不正な動作がアプリケーションコード、サーバーエラー、またはその他の原因によるものかを定義します。 #### クライアントアプリケーションのコーディング 1. システムのターミナルを開き、空のリソースディレクトリを作成します。 2. Catalystを初期化し、clientオプションを選択します。 3. クライアントアプリケーションをデプロイするために、作成したプロジェクトを選択します。 4. 以下のようにボイラープレートのクライアントコードが生成されます。 5. テキストエディタで開くと、以下のような構成になっています。 Note: ボイラープレートコード（clientフォルダおよびcatalyst.json）が生成される場所が、プロジェクトのホームロケーションです。 以下の表は、リソースディレクトリ内のファイルとその目的の一覧です。 <table class="content-table"> <thead> <tr> <th class="w10p">番号</th> <th class="w30p">ファイル/パッケージ</th> <th class="w60p">目的</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>client（フォルダ）</td> <td>クライアントアプリケーションの静的ファイル（js、css、htmlなど）を格納するフォルダです。</td> </tr> <tr> <td>2</td> <td>client-package.json</td> <td>クライアントアプリケーションの設定情報を含むJSONファイルです。</td> </tr> </tbody> </table> <br> ### client-package.jsonの構造 { "name": "SampleApp", "version": "1.0.0", "description": "This is my sample app", "homepage": "index.html", "login_redirect":"home.html" } 以下は client-package.jsonの属性です： <table class="content-table"> <thead> <tr> <th class="w30p">キー名</th> <th class="w70p">説明</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>クライアントアプリケーションの名前です。</td> </tr> <tr> <td>version</td> <td>クライアントアプリケーションのバージョンです。クライアントアプリケーションのバージョン管理の詳細については、<a href="/ja/cloud-scale/help/web-client-hosting/introduction">Web Client Hostingヘルプページ</a>を参照してください。</td> </tr> <tr> <td>description</td> <td>デプロイする現在のバージョンに関する簡単な説明です。</td> </tr> <tr> <td>homepage</td> <td>アプリケーションのランディングページです（例：<strong>index.html</strong>）。</td> </tr> <tr> <td>login_redirect</td> <td>ログインページ後にリダイレクトされるページです。アプリケーションにCatalyst Authenticationを統合する場合は必須です。詳細については、<a href="/ja/cloud-scale/help/authentication/introduction">Authentication</a>および<a href="/ja/api/code-reference/cloud-scale/authentication/add-new-user/#AddNewUser">Authentication API</a>ヘルプページを参照してください。</td> </tr> </tbody> </table> Client フォルダ内の適切なファイルに、WebアプリケーションのUI要素、JavaScriptファイル、およびCSSをコーディングできます。 <br> ### クライアントアプリケーションのデプロイ Catalyst CLIを使用してクライアントアプリケーションをデプロイできます。詳細については、リソースのデプロイヘルプページを参照してください。 1. システムのターミナルを開きます。 2. プロジェクトのホームロケーションから、以下のコマンドを使用してクライアントアプリをデプロイします： catalyst deploy --only client Note: Catalyst Webコンソールを使用してクライアントをデプロイすることもできます。 デプロイが完了すると、クライアントアプリケーションにアクセスするためのURLエンドポイントが取得できます。 <br /> #### Cloud Scale ##### Data Store -------------------------------------------------------------------------------- title: "コンポーネントインスタンスの取得" description: "このページでは、WebアプリケーションのData Storeからコンポーネントインスタンスを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.367Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/data-store/get-component-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # Data Store ### コンポーネントインスタンスの取得 datastore リファレンスは、以下のメソッドで作成できます。このメソッドはサーバーサイドの呼び出しを発生させません。 //Get a datastore instance var datastore = catalyst.table; -------------------------------------------------------------------------------- title: "テーブルインスタンスの取得" description: "このページでは、WebアプリケーションのData StoreのテーブルからテーブルIDおよびテーブル名を使用してテーブルインスタンスを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.367Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/data-store/get-table-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # テーブルオブジェクトの取得 table オブジェクトは、以下のメソッドで作成できます。これらのメソッドはサーバーサイドの呼び出しを発生させません。以下のコードスニペットで使用されている datastore リファレンスは、コンポーネントインスタンスです。 ### テーブルIDを使用したテーブルインスタンスの取得 table オブジェクトは、テーブルIDを参照して作成できます。 //Get a table object using table ID var table = datastore.tableId('1510000000110121'); ### テーブル名を使用したテーブルインスタンスの取得 または、table オブジェクトはテーブル名を参照して作成することもできます。 Note : 上記のメソッドにはPromiseは含まれず、テーブルオブジェクトにはテーブルからアクセスできるメソッドが含まれます。 //Get a table object using the table name var table = datastore.tableId('SampleTable'); -------------------------------------------------------------------------------- title: "テーブルメタデータの取得" description: "このページでは、Webアプリケーションで単一テーブルまたは複数テーブルのメタデータを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.367Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/data-store/get-table-meta/" service: "Cloud Scale" related: - Get Table Metadata - API (/ja/api/code-reference/cloud-scale/data-store/get-table-metadata/#GetTableMetadata) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # テーブルメタデータの取得 Catalyst Data Store内のテーブルのメタデータを取得できます。 ### 全テーブルのメタデータの取得 getAll() メソッドを使用して、Catalystプロジェクト内のすべてのテーブルの詳細を取得できます。以下のコードスニペットで使用されている datastore および table インスタンスは、それぞれ コンポーネントインスタンスと テーブルオブジェクトです。 このメソッドはPromiseを返し、content キーにすべてのテーブルのメタ詳細の配列を含むオブジェクトに解決されます。 //Get metadata of all the tables in the project var datastore = catalyst.table; var allTablePromise = datastore.getAll(); allTablePromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); 各バージョンで受け取るサンプルレスポンスを以下に示します: [ { "project_id":{ "project_name":"AlienCity", "id":"2136000000007733" }, "table_name":"AlienCity", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 01:47 PM", "table_id":"2136000000007781" }, "table_name":"CityDetails", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 01:47 PM", "table_id":"2136000000009090" } ] [ { "project_id":{ "project_name":"AlienCity", "id":2136000000007733 }, "table_name":"AlienCity", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "modified_time":"Aug 13, 2021 01:47 PM", "table_id":2136000000007781 }, "table_name":"CityDetails", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "modified_time":"Aug 13, 2021 01:47 PM", "table_id":2136000000009090 } ] -------------------------------------------------------------------------------- title: "カラムメタデータの取得" description: "このページでは、WebアプリケーションのData Storeのテーブルから単一カラムまたは複数カラムのメタデータを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.368Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/data-store/get-column-meta/" service: "Cloud Scale" related: - Get Column Metadata - API (/ja/api/code-reference/cloud-scale/data-store/get-column-metadata/#GetColumnMetadata) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # カラムメタデータの取得 Catalyst Data Storeのテーブル内の単一カラムのメタデータ詳細は、以下のメソッドで取得できます。以下のコードスニペットで使用されているテーブルリファレンスは、テーブルインスタンスまたはテーブルメタのいずれかです。 ### IDによるカラムメタデータの取得 getColumnDetails() メソッドを使用して、特定のテーブルのカラムメタデータを取得できます。 //Get The Column Object using Columnid var datastore = catalyst.table; var table = datastore.tableId("SampleTable"); var column = table.columnId(COLUMN_ID); 各バージョンで受け取るサンプルレスポンスを以下に示します: { table_id: "2305000000007003", column_sequence: "5", column_name: "CityName", category: 2, data_type: "varchar", audit_consent: false, max_length: "100", is_mandatory: false, decimal_digits: "2", is_unique: true, search_index_enabled: false, column_id: "2305000000007725" } { table_id: 2305000000007003, column_sequence: 5, column_name: "CityName", category: 2, data_type: "varchar", max_length: 100, is_mandatory: false, decimal_digits: 2, is_unique: true, search_index_enabled: false, column_id: 2305000000007725 } <br> ### 名前によるカラムメタデータの取得 カラムのメタデータを取得する別の方法として、カラム名を参照する方法があります。これは前のメソッドと同じレスポンスを返します。 カラムメタにはそれ以上の操作は含まれません。そのため、ここで返されるPromiseはJSONオブジェクトに解決されます。 //Get The Column Object using Columnname var datastore = catalyst.table; var table = datastore.tableId('SampleTable'); var column = table.columnId(COLUMN_NAME); 各バージョンで受け取るサンプルレスポンスを以下に示します: { table_id: "2305000000007003", column_sequence: "5", column_name: "CityName", category: 2, data_type: "varchar", audit_consent: false, max_length: "100", is_mandatory: false, decimal_digits: "2", is_unique: true, search_index_enabled: false, column_id: "2305000000007725" } { table_id: 2305000000007003, column_sequence: 5, column_name: "CityName", category: 2, data_type: "varchar", max_length: 100, is_mandatory: false, decimal_digits: 2, is_unique: true, search_index_enabled: false, column_id: 2305000000007725 } <br> ### カラムメタデータ詳細の取得 カラムのメタデータ詳細を取得するには、前の手順で作成したカラムオブジェクトのいずれかを使用する必要があります。これによりPromiseが返されます。 返されるPromiseは、content キーにカラムメタデータの詳細を含むオブジェクトに解決されます。 //Get The column details which in turn returns a promise var datastore = catalyst.table; var table = datastore.tableId('SampleTable'); var column = table.columnId(COLUMN_NAME); var columnPromise = column.get(); columnPromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); 各バージョンで受け取るサンプルレスポンスを以下に示します: { table_id: "2305000000007003", column_sequence: "5", column_name: "CityName", category: 2, data_type: "varchar", audit_consent: false, max_length: "100", is_mandatory: false, decimal_digits: "2", is_unique: true, search_index_enabled: false, column_id: "2305000000007725" } { table_id: 2305000000007003, column_sequence: 5, column_name: "CityName", category: 2, data_type: "varchar", max_length: 100, is_mandatory: false, decimal_digits: 2, is_unique: true, search_index_enabled: false, column_id: 2305000000007725 } <br> ### 全カラムのメタデータの取得 単一カラムのメタデータの取得に加えて、getAllColumns() メソッドを使用して、特定のテーブルの全カラムのメタデータを取得できます。 Note : ここで返されるPromiseは、カラムメタ詳細の配列に解決されます。 //Get all the columns in the table which in turn returns a promise var datastore = catalyst.table; var table = datastore.tableId('SampleTable'); var allcolumnPromise = table.getColumns(); allcolumnPromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); 各バージョンで受け取るサンプルレスポンスを以下に示します: [ { table_id: "2136000000007781", column_sequence: "1", column_name: "ROWID", category: 1, data_type: "bigint", audit_consent: false, max_length: "50", is_mandatory: false, decimal_digits: "2", is_unique: false, search_index_enabled: false, column_id: "2136000000007784" }, { table_id: "2136000000007781", column_sequence: "2", column_name: "CREATORID", category: 1, data_type: "bigint", max_length: "50", is_mandatory: false, decimal_digits: "2", is_unique: false, search_index_enabled: true, column_id: "2136000000007786" }, { table_id: "2136000000007781", column_sequence: "3", column_name: "CREATEDTIME", category: 1, data_type: "datetime", max_length: "50", is_mandatory: false, decimal_digits: "2", is_unique: false, search_index_enabled: true, column_id: "2136000000007788" }, { table_id: "2136000000007781", column_sequence: "4", column_name: "MODIFIEDTIME", category: 1, data_type: "datetime", max_length: "50", is_mandatory: false, decimal_digits: "2", is_unique: false, search_index_enabled: true, column_id: "2136000000007790" }, { table_id: "2136000000007781", column_sequence: "5", column_name: "CityName", category: 2, data_type: "varchar", max_length: "100", is_mandatory: false, decimal_digits: "2", is_unique: true, search_index_enabled: true, column_id: "2136000000008503" } ] [ { table_id: 2136000000007781, column_sequence: 1, column_name: "ROWID", category: 1, data_type: "bigint", max_length: 50, is_mandatory: false, decimal_digits: 2, is_unique: false, search_index_enabled: false, column_id: 2136000000007784 }, { table_id: 2136000000007781, column_sequence: 2, column_name: "CREATORID", category: 1, data_type: "bigint", max_length: 50, is_mandatory: false, decimal_digits: 2, is_unique: false, search_index_enabled: true, column_id: 2136000000007786 }, { table_id: 2136000000007781, column_sequence: 3, column_name: "CREATEDTIME", category: 1, data_type: "datetime", max_length: 50, is_mandatory: false, decimal_digits: 2, is_unique: false, search_index_enabled: true, column_id: 2136000000007788 }, { table_id: 2136000000007781, column_sequence: 4, column_name: "MODIFIEDTIME", category: 1, data_type: "datetime", max_length: 50, is_mandatory: false, decimal_digits: 2, is_unique: false, search_index_enabled: true, column_id: 2136000000007790 }, { table_id: 2136000000007781, column_sequence: 5, column_name: "CityName", category: 2, data_type: "varchar", max_length: 100, is_mandatory: false, decimal_digits: 2, is_unique: true, search_index_enabled: true, column_id: 2136000000008503 } ] -------------------------------------------------------------------------------- title: "行の挿入" description: "このページでは、WebアプリケーションのData Storeのテーブルに単一行または一括で行を挿入するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.368Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/data-store/insert-rows/" service: "Cloud Scale" related: - Insert Rows - API (/ja/api/code-reference/cloud-scale/data-store/insert-new-row/#InsertNewRow) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の挿入 テーブルの一意のIDまたは名前を参照して、Data Storeのテーブルに新しいデータ行またはレコードを挿入できます。同じ操作でテーブルに複数の行を挿入することもできます。 Note: 1. テーブルとそのカラムは事前に作成されている必要があります。テーブルとカラムはコンソールから作成できます。 2. 開発環境では、各プロジェクトの各テーブルに最大5000レコードを挿入できます。開発環境では、各プロジェクト全体で最大25,000レコードを作成できます。本番環境ではレコード作成の上限はありません。 テーブルに挿入する行を含む配列を構築し、以下に示すように addRow() メソッドの引数として配列を渡す必要があります。これにより、一意の名前またはIDで参照するテーブルに行が挿入されます。行は {カラム名 : カラム値} 形式で指定します。ここで返されるPromiseはオブジェクトに解決され、content キーに行の配列が含まれます。 以下のコードで使用されている table リファレンスは、先に作成したテーブルオブジェクトです。 //配列を作成する with the rows to be inserted var details = [ {"Name": "Heather Drake", "Age": 26}, {"Name": "Lucy Park", "Age": 34} ]; //配列を渡して行を挿入し、Promiseを返す var datastore = catalyst.table; var table = datastore.tableId('EmpDetails'); //Provide the table ID or table name to insert the rows var insertPromise = table.addRow(details); //Pass the JSON array insertPromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); 受け取るサンプルレスポンスを以下に示します。レスポンスは両方のバージョンで同じです。 #### Web SDK [ { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-25 13:55:04:904", Name: "Heather Drake", Age: 26, CREATEDTIME: "2021-08-25 13:55:04:904", ROWID: 2136000000038008 }, { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-25 13:55:04:906", Name: "Lucy Park", Age: 34, CREATEDTIME: "2021-08-25 13:55:04:906", ROWID: 2136000000038010 } ] -------------------------------------------------------------------------------- title: "行の更新" description: "このページでは、WebアプリケーションのData Storeのテーブル内の単一行または一括で行を更新するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.368Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/data-store/update-rows/" service: "Cloud Scale" related: - Update Rows - API (/ja/api/code-reference/cloud-scale/data-store/update-row/#UpdateRow) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の更新 テーブル内の単一行または複数行を1つ以上のカラム値で更新する場合、以下のメソッドを使用します。以下のコードスニペットで使用されている table は、テーブルオブジェクトです。 Note : ここで返されるPromiseは、content キーに更新された行の詳細の配列を含むオブジェクトに解決されます。 //Create an object with the details to be updated referring to the corresponding ROWID var details = [ { "Name": "John Denver", "Age": 25, "ROWID": 1510000000085482}, { "Name": "Jill Scott", "Age": 39, "ROWID": 1510000000113707} ]; //詳細を使用してRowオブジェクトを更新する var datastore = catalyst.table; var table = datastore.tableId('SampleTable'); var updatePromise = table.updateRow(details); updatePromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); 受け取るサンプルレスポンスを以下に示します。レスポンスは両方のバージョンで同じです。 #### Web SDK [ { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-24 13:22:14:718", CREATEDTIME: "2021-08-24 13:12:55:999", Name: "John Denver", Age: 25 ROWID: "2136000000034043" }, { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-24 13:22:14:728", CREATEDTIME: "2021-08-24 13:12:56:001", Name: "Jill Scott", Age: 39 ROWID: "2136000000034045" } ] -------------------------------------------------------------------------------- title: "行の取得" description: "このページでは、WebアプリケーションのData Storeのテーブルから単一行またはすべての行を取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.368Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/data-store/get-rows/" service: "Cloud Scale" related: - Get Rows - API (/ja/api/code-reference/cloud-scale/data-store/get-all-rows/#GetAllRows) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の取得 Catalyst Data Storeのテーブルから、単一行または複数行のデータを取得できます。これらのコードスニペットで使用されている table オブジェクトは、コンポーネントインスタンスページで定義されています。 ### 行オブジェクトの取得 Data Storeのテーブルから行を取得する前に、以下に示すように行の一意のRow IDを使用して行オブジェクトを作成する必要があります。これはサーバーサイドの呼び出しを発生させません。 //Create a row object using the Rowid var datastore = catalyst.table; var table = datastore.tableId("ShipmentTracking"); var row = table.rowId("12781121212121"); ### 単一行の取得 get() メソッドを使用して、テーブルから単一行を取得できます。以下に示すように、前のセクションで作成した行オブジェクトに行の一意のRow IDを渡す必要があります。 ここで返されるPromiseは、content キーに行オブジェクトを含むJSON行オブジェクトに解決されます。 //Fetch the row details by passing the row ID to the row object var datastore = catalyst.table; var table = datastore.tableId('ShipmentTracking'); var row = table.rowId("12781121212121"); var rowPromise = row.get(); rowPromise.then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); 受け取るサンプルレスポンスを以下に示します。レスポンスはWeb SDKの全バージョンで同じです。 { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-17 13:02:11:184", CREATEDTIME: "2021-08-16 16:29:10:499", CityName: "Pune", ROWID: "2136000000011011" } ### ページネーションによる全行の取得 getPagedRows() ファンクションを使用して、コードにページネーションを組み込むことで、Data Storeのテーブルからすべての行データを取得できます。ページネーションを使用すると、テーブルの行をイテレーションを通じてバッチまたはページ単位で取得できます。 このイテレーションは、以下のサンプルコードに示すように hasNext によって検証され、すべての行が取得されるまで実行されます。テーブルは一意のテーブルIDまたは名前で参照できます。 たとえば、個別のページとして100件ずつバッチで行を取得する場合、以下に示すように max_rows パラメータのカウントを100に指定できます。 Note: max_rows パラメータはオプションです。この値が指定されない場合、SDK呼び出しはデフォルトで単一ページに200行を返します。 また、ループの各実行後、レスポンスデータに後続のデータ取得を認可するトークン文字列が返されます。以下に示すように、後続のイテレーション中に next_token パラメータを通じてこのトークンを渡す必要があります。ループの最初の実行時、next_token 文字列の値は undefined が割り当てられます。次のレコードセットは、レスポンスデータの more_records を通じて取得されます。 Note: ページネーションはWeb SDK v3.1.0アップデートから利用可能になりました。以前のバージョンのWeb SDKでは利用できません。 { if (!hasNext) { return; } catalyst.table .tableId('userDetails') //Specify the Table ID or Table name of the table to fetch the records from .getPagedRows({ next_token, max_rows: 100 }) //1ページで取得する最大行数を定義する and pass it along with nextToken .then(resp => { console.log('rows : ', resp.content); //テーブルから行を取得する return getMyPagedRows(resp.more_records, resp.next_token); //次のレコードセットと次の反復用のトークン文字列を取得する }) .catch((err) => { console.log(err.toString()); }); } さらにレコードが利用可能な場合に受け取るサンプルレスポンスを以下に示します。この場合、more_records パラメータは true に設定されます。 #### Web SDK v3.1.0 { "status": 200, "content": [ { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:24:855", "name": "raj", "CREATEDTIME": "2022-01-11 18:18:24:855", "ROWID": "3359000000108111" }, { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:25:117", "name": "raj", "CREATEDTIME": "2022-01-11 18:18:25:117", "ROWID": "3359000000108114" }, { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:25:120", "name": "raj", "CREATEDTIME": "2022-01-11 18:18:25:120", "ROWID": "3359000000108117" } ], "message": "OK", "more_records": true, "next_token": "{{token}}" } これ以上レコードが利用できない場合に受け取るサンプルレスポンスを以下に示します。この場合、more_records パラメータは false に設定されます。 { "status": 200, "content": [ { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:43:556", "name": "raj99", "CREATEDTIME": "2022-01-11 18:18:43:556", "ROWID": "3359000000108410" }, { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:43:557", "name": "raj98", "CREATEDTIME": "2022-01-11 18:18:43:557", "ROWID": "3359000000108413" }, { "CREATORID": "3359000000006003", "MODIFIEDTIME": "2022-01-11 18:18:43:568", "name": "raj96", "CREATEDTIME": "2022-01-11 18:18:43:568", "ROWID": "3359000000108417" } ], "message": "OK", "more_records": false } Note: テーブルから複数行のデータを取得するために以前のバージョンのWeb SDKで利用可能だった getAllRows() メソッドのサポートは廃止されました。ページネーションは、取得する行数の制限なくすべての行を取得できる拡張機能として利用可能になりました。getAllRows() メソッドは、今後のすべてのSDKバージョンから削除されます。コードを適宜アップグレードしてください。 -------------------------------------------------------------------------------- title: "行の削除" description: "このページでは、WebアプリケーションのData Storeのテーブルから単一行を削除するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.368Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/data-store/delete-row/" service: "Cloud Scale" related: - Delete Row - API (/ja/api/code-reference/cloud-scale/data-store/delete-row/#DeleteRow) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の削除 単一行は削除できますが、複数行を同時に削除することはできません。以下のコードスニペットで使用されている _row_ は、行オブジェクトです。delete() メソッドのパラメータとして ROWID を渡すだけで、テーブルから行を削除できます。 Note : ここで返されるPromiseは、content キーに削除された行オブジェクトを含むオブジェクトに解決されます。 //Delete the row which in turn returns a promise var datastore = catalyst.table; var table = datastore.tableId('SampleTable'); var row = table.rowId(ROW_ID); var rowPromise = row.delete(); rowPromise.then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); -------------------------------------------------------------------------------- title: "行の一括削除" description: "このページでは、WebアプリケーションのData Storeのテーブルから行を一括削除するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.368Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/data-store/bulk-delete-rows/" service: "Cloud Scale" related: - Bulk Delete Rows - API (/ja/api/code-reference/cloud-scale/data-store/bulk-delete-rows/#BulkDeleteRows) - Data Store (/ja/cloud-scale/help/data-store/introduction) -------------------------------------------------------------------------------- # 行の一括削除 Catalystでは、Data Storeの特定のテーブルからレコードまたはデータ行を一括で削除できます。テーブルは一意のIDまたは名前で参照します。テーブルIDはData Storeから、またはコンソールでテーブルを開いた際のURLから取得できます。 一括削除操作では、1回の操作で最大200行を削除できます。以下のサンプルコードに示すように、削除する行の一意のROWIDを配列で渡すことができます。コードには少なくとも1つのROWIDを含める必要があり、最大200のROWIDを含めることができます。 配列は変数に割り当てられ、サンプルコードの deletePromise を通じて deleteRows() ファンクションに渡されます。テーブル名またはテーブルIDは datastore.tableId() に渡す必要があります。 以下で使用されている datastore リファレンスは、コンポーネントインスタンスページで定義されています。 var datastore = catalyst.table; //テーブルIDまたはテーブル名を渡す var table = datastore.tableId('EmpDetails'); //削除するレコードのROWIDを宣言する var rowIds =[1028000000171815, 1028000000171810, 1028000000171805, 1028000000171617, 1028000000171098]; //ROWIDの配列をdeleteRows()関数に渡す var deletePromise = table.deleteRows(rowIds); //Promiseを返しブラウザコンソールに表示する deletePromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); ##### File Store -------------------------------------------------------------------------------- title: "コンポーネントインスタンスの取得" description: "このページでは、WebアプリケーションのFile Storeからフォルダーを削除するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.368Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/file-store/get-component-instance/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction/) -------------------------------------------------------------------------------- # File Store Catalyst File Storeは、Catalystアプリケーションのアプリケーションファイルやユーザーデータファイルのクラウドストレージソリューションを提供し、共有データへのアクセスを可能にします。画像、動画、テキストファイル、ドキュメントファイル、スプレッドシート、その他の形式のファイルを保存、管理、整理できます。 ### コンポーネントインスタンスの取得 file store コンポーネントインスタンスは、以下のように作成できます。これはサーバーサイドの呼び出しを発生させません。 //Get a file store instance var filestore = catalyst.file; -------------------------------------------------------------------------------- title: "フォルダーインスタンスの取得" description: "このページでは、WebアプリケーションのFile Storeからフォルダーインスタンスを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.368Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/file-store/get-folder-instance/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction/) -------------------------------------------------------------------------------- # フォルダーオブジェクトの取得 folder オブジェクトは、以下のコードスニペットを使用して作成できます。これはサーバーサイドの呼び出しを発生させません。以下のコードスニペットで使用されている filestore は、コンポーネントインスタンスです。 Note : 上記のメソッドにはPromiseは含まれず、フォルダーオブジェクトが返されます。 // フォルダーインスタンスを取得する var filestore = catalyst.file; var folder = filestore.folderId(FOLDER_ID); -------------------------------------------------------------------------------- title: "フォルダー詳細の取得" description: "このページでは、Node.jsアプリケーションのFile Storeからフォルダー詳細を取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.368Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/file-store/retrieve-folder-details/" service: "Cloud Scale" related: - Retrieve Folder Details - API (/ja/api/code-reference/cloud-scale/file-store/get-specific-folder/#GetSpecificFolder) - File Store (/ja/cloud-scale/help/file-store/introduction/) -------------------------------------------------------------------------------- # フォルダー詳細の取得 ### 単一フォルダーの詳細の取得 一意のフォルダーIDで参照される特定のフォルダーの詳細を取得するメソッドは、get() メソッドです。以下のコードスニペットで使用されている folder は、フォルダーオブジェクトです。 Note : ここで返されるPromiseは、content キーに単一フォルダーの詳細を含むオブジェクトに解決されます。 //Get the folder details using the folder Object var filestore = catalyst.file; var folder = filestore.folderId(2136000000008551); var folderPromise = folder.get(); folderPromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); 各バージョンで受け取るサンプルレスポンスを以下に示します: { "folder_name":"Store_Data", "created_time":"Aug 13, 2021 05:32 PM", "created_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "modified_time":"Aug 13, 2021 05:32 PM", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":"2136000000006003" }, "project_details":{ "project_name":"ShipmentTracking", "id":"2136000000007733", "project_type":"Live" }, "file_details":[ { "id":"2136000000020111", "file_location":null, "file_name":"Img.jpeg", "file_size":"84881", "created_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"p.boyle@zylker.com", "first_name":"Patricia", "last_name":"Boyle", "user_type":"Admin", "user_id":"2136000000006767" }, "created_time":"Aug 17, 2021 09:32 PM", "modified_by":{ "zuid":"66466723", "is_confirmed":false, "email_id":"p.boyle@zylker.com", "first_name":"Patricia", "last_name":"Boyle", "user_type":"Admin", "user_id":"2136000000006767" }, "modified_time":"Aug 17, 2021 09:32 PM", "project_details":{ "project_name":"ShipmentTracking", "id":"2136000000007733", "project_type":"Live" }, "folder_details":"2136000000008551" } ], "id":"2136000000008551" } { "folder_name":"Store_Data", "created_time":"Aug 13, 2021 05:32 PM", "created_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "modified_time":"Aug 13, 2021 05:32 PM", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "project_details":{ "project_name":"ShipmentTracking", "id":2136000000007733, "project_type":"Live" }, "file_details":[ { "id":2136000000020111, "file_location":null, "file_name":"invoice1349.jpeg", "file_size":84881, "created_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"p.boyle@zylker.com", "first_name":"Patricia", "last_name":"Boyle", "user_type":"Admin", "user_id":2136000000006767 }, "created_time":"Aug 17, 2021 09:32 PM", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"p.boyle@zylker.com", "first_name":"Patricia", "last_name":"Boyle", "user_type":"Admin", "user_id":2136000000006767 }, "modified_time":"Aug 17, 2021 09:32 PM", "project_details":{ "project_name":"ShipmentTracking", "id":2136000000007733, "project_type":"Live" }, "folder_details":2136000000008551 } ], "id":2136000000008551 } File Storeに作成されたフォルダーの詳細を取得できます。単一フォルダーまたはFile Store内のすべてのフォルダーが対象となります。以下のコードスニペットで使用されている _filestore_ は、コンポーネントインスタンスです。 ### 全フォルダーの詳細の取得 Catalystプロジェクト内のすべてのフォルダーの詳細を取得する場合、getAllFolder() メソッドを使用します。 Note : ここで返されるPromiseは、content キーにすべてのフォルダー詳細の配列を含むオブジェクトに解決されます。 //Get all the folders by calling the method which in turn return a promise var filestore = catalyst.file; var allFolderPromise = filestore.getAllFolder(); allFolderPromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); 各バージョンで受け取るサンプルレスポンスを以下に示します: [ { folder_name: "Store_Data", created_time: "Jul 05, 2023 12:42 PM", created_by: { zuid: 788778872, is_confirmed: false, email_id: "amelia.burrows@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: 10103000000003004 }, modified_time: "Jul 05, 2023 12:42 PM", modified_by: { zuid: 788778872, is_confirmed: false, email_id: "amelia.burrows@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: 10103000000003004 }, project_details: { project_name: "Shipment_Tracking", id: 10103000000115000, project_type: "Live" }, audit_consent: false, id: 10103000000114006 }, { folder_name: "Git_Details", created_time: "Jul 05, 2023 12:36 PM", created_by: { zuid: 788778872, is_confirmed: false, email_id: "amelia.burrows@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: 10103000000003004 }, modified_time: "Jul 05, 2023 12:36 PM", modified_by: { zuid: 788778872, is_confirmed: false, email_id: "amelia.burrows@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: 10103000000003004 }, project_details: { project_name: "GitHubBot", id: 10103000000115000, project_type: "Live" }, audit_consent: false, id: 10103000000115076 } ] [ { "folder_name":"Invoices", "created_time":"Aug 25, 2021 11:38 AM", "created_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "modified_time":"Aug 25, 2021 11:38 AM", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "project_details":{ "project_name":"ShipmentTracking", "id":2136000000007733, "project_type":"Live" }, "id":2136000000037021 }, { "folder_name":"Store_Data", "created_time":"Aug 13, 2021 05:32 PM", "created_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "modified_time":"Aug 13, 2021 05:32 PM", "modified_by":{ "zuid":66466723, "is_confirmed":false, "email_id":"emma@zylker.com", "first_name":"Amelia", "last_name":"Burrows", "user_type":"Admin", "user_id":2136000000006003 }, "project_details":{ "project_name":"ShipmentTracking", "id":2136000000007733, "project_type":"Live" }, "id":2136000000008551 } ] -------------------------------------------------------------------------------- title: "ファイルのアップロード" description: "このページでは、WebアプリケーションのFile Storeのフォルダーにファイルをアップロードするメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.369Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/file-store/upload-file/" service: "Cloud Scale" related: - Upload File - API (/ja/api/code-reference/cloud-scale/file-store/upload-file-in-folder/#UploadFileInaFolder) - File Store (/ja/cloud-scale/help/file-store/introduction/) -------------------------------------------------------------------------------- # ファイルのアップロード フォルダーの一意のIDを参照して、ローカルシステムからFile Store内の既存フォルダーにファイルをアップロードできます。画像、テキストドキュメント、CSV、その他必要な任意のタイプのファイルをアップロードできます。アップロードできるファイルの最大サイズは100 MBです。 Note: Catalystは、開発環境では各プロジェクトに1 GBのFile Storeスペースを提供します。本番環境ではストレージの上限はありません。 以下に示すように、アップロードするファイルのファイルオブジェクトを作成する必要があります。fileobject は uploadFile() メソッドの引数として渡されます。アップロードは start() メソッドが呼び出されたときにのみ開始されます。フォルダーを参照する際にフォルダーIDを指定する必要があります。 以下のコードで使用されている folder リファレンスは、先に作成したフォルダーオブジェクトです。 ここで返されるPromiseは、content キーにアップロードされたファイルの詳細を含むオブジェクトに解決されます。ファイルがアップロードされると、ファイルに一意のファイルIDが作成されます。 var filestore = catalyst.file; var folder = filestore.folderId(7189310908031); //Specify the Folder ID var uploadPromise = folder.uploadFile(fileobject).start(); //Pass the file object and upload the file uploadPromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); 各バージョンで受け取るサンプルレスポンスを以下に示します: { id: "2136000000020122", file_location: null, file_name: "shipmentdetails.csv", file_size: "84881", created_by: { zuid: "66466723", is_confirmed: false, email_id: "amelia.burrows@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: "2136000000006003" }, created_time: "Aug 17, 2021 09:33 PM", modified_by: { zuid: "66466723", is_confirmed: false, email_id: "amelia.burrows@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: "2136000000006003" }, modified_time: "Jul 06, 2023 11:38 AM", project_details: { project_name: "ShipmentTracking", id: 10103000000115000, project_type: "Live" }, folder_details: 10103000000114006 } { id: 2136000000020117, file_location: null, file_name: "empdata.csv", file_size: 84881, created_by: { zuid: 66466723, is_confirmed: false, email_id: "emma@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: 2136000000006003 }, created_time: "Aug 17, 2021 09:33 PM", modified_by: { zuid: 66466723, is_confirmed: false, email_id: "emma@zylker.com", first_name: "Amelia", last_name: "Burrows", user_type: "Admin", user_id: 2136000000006003 }, modified_time: "Aug 17, 2021 09:33 PM", project_details: { project_name: "ShipmentTracking", id: 2136000000007733 }, folder_details: 2136000000008551 } -------------------------------------------------------------------------------- title: "ファイルオブジェクトの取得" description: "このページでは、WebアプリケーションのFile Storeからファイルオブジェクトを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.369Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/file-store/get-file-object/" service: "Cloud Scale" related: - File Store (/ja/cloud-scale/help/file-store/introduction/) -------------------------------------------------------------------------------- # ファイルオブジェクトの取得 file オブジェクトは、以下のコードスニペットを使用して作成できます。これはサーバーサイドの呼び出しを発生させません。ここでは一意のファイルIDが引数として渡されます。以下のコードスニペットで使用されている folder は、フォルダーオブジェクトです。 //Get a file object by passing the file ID var filestore = catalyst.file; var folder = filestore.folderId(FOLDER_ID); var file = folder.fileId(FILE_ID); -------------------------------------------------------------------------------- title: "フォルダーからのファイルダウンロード" description: "このページでは、WebアプリケーションのFile Storeのフォルダーからファイルをダウンロードするメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.369Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/file-store/download-file-from-folder/" service: "Cloud Scale" related: - Download a File from the Folder - API (/ja/api/code-reference/cloud-scale/file-store/download-file-from-folder/#DownloadaFileFromaFolder) - File Store (/ja/cloud-scale/help/file-store/introduction/) -------------------------------------------------------------------------------- # フォルダーからのファイルダウンロード 他のSDKとは異なり、Catalyst Web SDKでは実際のファイルをダウンロードできるファイルのダウンロードURLを取得できます。URLからダウンロードするファイルを特定するために、folder ID と file ID が必要です。以下のコードスニペットで使用されている file は、ファイルオブジェクトです。Promiseを返すには getDownloadLink() メソッドを使用します。 Note : ここで返されるPromiseは、contentキーにダウンロードURLが利用可能な download_url キーを含むオブジェクトに解決されます。 //Get the download Link by calling the method which returns a promise. var filestore = catalyst.file; var folder = filestore.folderId(FOLDER_ID); var file = folder.fileId(FILE_ID); var downloadPromise = file.getDownloadLink(); downloadPromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); -------------------------------------------------------------------------------- title: "ファイルの削除" description: "このページでは、WebアプリケーションのFile Storeからファイルを削除するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.369Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/file-store/delete-file/" service: "Cloud Scale" related: - Delete File - API (/ja/api/code-reference/cloud-scale/file-store/delete-file/#DeleteFile) - File Store (/ja/cloud-scale/help/file-store/introduction/) -------------------------------------------------------------------------------- # ファイルの削除 delete() メソッドは、フォルダーからファイルを削除するために使用されます。以下のコードスニペットで使用されている file は、ファイルオブジェクトです。 Note : ここで返されるPromiseは、content キーに削除されたファイルの詳細を含むオブジェクトに解決されます。 //Delete the file by calling the method which returns a promise. var filestore = catalyst.file; var folder = filestore.folderId(FOLDER_ID); var file = folder.fileId(FILE_ID); var deletePromise = file.delete(); deletePromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); ##### Stratus -------------------------------------------------------------------------------- title: "概要" description: "このページでは、Stratusで操作を実行するためのWeb SDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.369Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/stratus/overview/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/overview/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/overview/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/overview/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # 概要 Cloud Scale Stratusは、Catalystの堅牢で強力なストレージソリューションです。Bucketsと呼ばれるコンテナに、あらゆる形式のデータをObjectsとして保存できます。各Bucketおよびバケット内の個々のオブジェクトには、安全なObject URLとBucket URLがあります。オブジェクトに対してアップロードおよびダウンロード操作を実行でき、各オブジェクトにカスタム権限を付与することもできます。 Note: * CORSを有効にして、必要なアプリケーションまたはAppSailサービスドメインをホワイトリストに登録し、以下のSDKを使用することをお勧めします。 * Stratus SDKメソッドを使用するには、Web SDKをv4.5.0-betaにアップグレードする必要があります。 * また、Catalyst CLIをv1.18.0-beta.5にアップグレードする必要があります。 以下の表には、コードを通じてStratus操作を実行するために使用できるすべてのCatalyst SDKの一覧が含まれています。 <table class="content-table"> <thead> <tr> <th class="w30p">カテゴリ</th> <th class="w70p">SDKメソッド</th> </tr> </thead> <tbody> <tr> <td>一般的なStratus操作</td> <td> <ul> <li>Stratusインスタンスの作成 <ul> <li>Bucketインスタンスの初期化</li> </ul> </li> </ul> </td> </tr> <tr> <td>Bucket操作</td> <td> <ul> <li>オブジェクトの可用性確認 <ul> <li>VersionIDなしのオブジェクト可用性確認</li> <li>VersionID付きのオブジェクト可用性確認</li> </ul> </li> <li>オブジェクトのダウンロード <ul> <li>オブジェクト名を使用したオブジェクトのダウンロード</li> <li>特定バージョンのオブジェクトのダウンロード</li> <li>プロセスコールバック付きオブジェクトのダウンロード</li> <li>オブジェクトの特定部分のダウンロード</li> <li>署名付きURLを使用したオブジェクトのダウンロード <ul> <li>非同期ファンクションの使用</li> <li>Promiseの使用</li> <li>オプション付きSignedURLの使用</li> </ul> </li> <li>キャッシュURLを使用したキャッシュオブジェクトのダウンロード</li> </ul> </li> <li>オブジェクトのアップロード <ul> <li>ファイルとしてオブジェクトをアップロード</li> <li>文字列としてオブジェクトをアップロード</li> <li>オプション付きオブジェクトのアップロード</li> <li>プロセスコールバック付きオブジェクトのアップロード</li> <li>メタ詳細付きオブジェクトのアップロード</li> <li>マルチパートアップロード</li> <li>すべてのマルチパート機能をラップしたオブジェクトのアップロード</li> </ul> </li> <li>オブジェクトの削除 <ul> <li>オブジェクト名によるオブジェクトの削除</li> <li>オブジェクト名とVersionIDによるオブジェクトの削除</li> </ul> </li> </ul> </td> </tr> </tbody> </table> -------------------------------------------------------------------------------- title: "Stratusインスタンスの作成" description: "このページでは、Stratusインスタンスを初期化するWeb SDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.369Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/stratus/initialize-stratus-instance/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/create-stratus-instance/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/create-stratus-instance/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/create-stratus-instance/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/create-bucket-instance/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/create-bucket-instance/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/initialize-stratus/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # Stratusインスタンスの作成 以下のように stratus コンポーネントリファレンスを取得できます。これはサーバーサイドの呼び出しを発生させません。このコンポーネントインスタンスは、Stratusを使用するさまざまなコードスニペットで参照します。 const stratus = catalyst.stratus ### Bucketインスタンスの初期化 バケットレベルの操作を実行するには、バケットインスタンスを初期化する必要があります。このコンポーネントインスタンスは、StratusのBucketsを使用するさまざまなコードスニペットで参照します。 const bucket = stratus.bucket("bucketName") -------------------------------------------------------------------------------- title: "オブジェクトの可用性確認" description: "このページでは、バケット内にオブジェクトが存在するかどうかを確認するWeb SDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.369Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/stratus/check-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/check-bucket/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/check-bucket/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/check-bucket/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/overview/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/overview/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/overview/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトの可用性確認 headObject() SDKメソッドを使用して、バケット内のオブジェクトの存在を確認し、さらにユーザーがバケット内のオブジェクトにアクセスするための適切な権限を持っているかどうかを確認できます。以下のコードスニペットで使用されているBucketリファレンスは、コンポーネントインスタンスです。 このSDKを使用した場合の可能なレスポンス: * バケットが存在し、ユーザーがバケット内のオブジェクトにアクセスするための適切な権限を持っている場合、レスポンス「**true**」が返されます。 * バケットが存在しない場合、またはユーザーがバケット内のオブジェクトにアクセスする権限を持っていない場合、レスポンス「**false**」が返されます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトのパスを含む完全な名前を保持します。</td> </tr> <tr> <td>options</td> <td>JSON Object</td> <td>以下のパラメータを保持するオプションパラメータです: <ul> <li>versionId: <ul> <li>オプションのStringパラメータです。</li> <li>バケットでバージョニングが有効になっている場合、このパラメータを使用して一意のVersion IDで特定のバージョンを参照できます。</li> </ul> </li> <li>throwErr: <ul> <li>オプションのBooleanパラメータです。</li> <li>このパラメータを「true」に設定すると、プロジェクトにバケットが見つからない場合にエラーをスローします。</li> <li>デフォルト値は「false」です。</li> </ul> </li> </ul> </td> </tr> </tbody> </table> ### VersionIDなしのオブジェクト可用性確認 以下のSDKメソッドは、バケット内のオブジェクトの topVersion（最新バージョン）を提供します。 // オブジェクトが利用可能か確認する const checkObjectAvailability = await bucket.headObject("key") ### VersionID付きのオブジェクト可用性確認 以下のSDKメソッドは、オブジェクトの特定バージョンの可用性を確認します。必要なバージョンは一意の versionId で参照されます。 // オブジェクトの特定バージョンが利用可能か確認する const options = { versionId: 'djkfhdiufy762', throwErr: false }; const checkObjectAvailability = await bucket.headObject("key", options) **レスポンス例** { "status": 200, "content": true | false, "message": "OK" } -------------------------------------------------------------------------------- title: "オブジェクトのダウンロード" description: "このページでは、Stratusからオブジェクトを取得するWeb SDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.369Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/stratus/download-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/download-object/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/download-object/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/download-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/download-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/download-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/download-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトのダウンロード このSDKメソッドは、バケットからオブジェクトをダウンロードするために使用できます。レスポンスは**blob**形式になります。以下のコードスニペットで使用されているStratusリファレンスは、コンポーネントインスタンスです。 バケットのバージョニングステータスに関する想定レスポンス: * versionId を渡さない場合、リクエストで指定したキーとともに**最新のオブジェクト**が返されます。 * バケットでバージョニングが有効にされた後、無効にされた場合。デフォルトでは、プリンシパルの最初のオブジェクトが返されます。このオブジェクトの最新バージョンをダウンロードするには、versionId パラメータに「topVersion」の値を渡す必要があります。 * 特定のバージョンを取得するには、versionId クエリパラメータに有効なバージョンを値として使用します。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>オブジェクトの名前を保持します。</td> </tr> <tr> <td>options</td> <td>JSON Object</td> <td> <ul> <li>versionId: オプションのStringパラメータです。必要なオブジェクトバージョンの一意の version ID を保持します。 </li> <li>range: オプションのStringパラメータです。必要なオブジェクトのバイト範囲です。オブジェクトの特定部分を取得するために使用されます。</li> <li>cached: オプションのBooleanパラメータです。 <ul> <li>オブジェクトのキャッシュバージョンを取得するために使用されます。</li> <li>「true」または「false」の2つの値のみを受け付けます。</li> <li>このパラメータが使用されない場合、値は false になります。</li> <li>バケットでキャッシュが有効で、このパラメータを渡した場合、値は true になります。この場合、オブジェクトはキャッシュドメインから取得されます。</li> </ul> </li> <li>signed: オプションのBooleanパラメータです。デフォルト値は「false」です。署名付きURLを取得するためのAPI呼び出しを行います。 </li> <li>signedUrlFn: <ul> <li>オプションのFunctionパラメータです。</li> <li>サーバーSDK（Java、Node.js、およびPython）で提供される署名付きURL APIレスポンスを返すコールバックファンクションです。ファイルをダウンロードするために使用されます。</li> <li>このファンクションは非同期ファンクションとPromiseのみを受け付けます。</li> <li>このファンクションを使用すると、CatalystはキャッシュURLと有効期限をパラメータとして渡し、署名付きURLの生成に使用できます。</li> </ul> </li> </ul> </td> </tr> <tr> <td>processCallback</td> <td>Function</td> <td>ファイルダウンロード中のコールバックファンクションです。</td> </tr> </tbody> </table> ### オブジェクト名を使用したオブジェクトのダウンロード 以下のSDKスニペットを使用すると、key を使用してStratusのバケットからオブジェクトをダウンロードできます。 const getObject = await bucket.getObject("key"); const getObjectStart = getObject.start(); // リクエストを開始する const getObjectAbort = getObject.abort(); // リクエストを中止する ### 特定バージョンのオブジェクトのダウンロード 以下のSDKスニペットを使用すると、key と versionId を使用してStratusのバケットから特定バージョンのオブジェクトをダウンロードできます。 const options = { 'versionId': 'djkshr8374yiuhf48', // オブジェクトの特定バージョンをダウンロードする } const getObject = await bucket.getObject("key", options); const getObjectStart = getObject.start(); // リクエストを開始する const getObjectAbort = getObject.abort(); // リクエストを中止する ### プロセスコールバック付きオブジェクトのダウンロード 以下のSDKスニペットを使用すると、プロセスコールバックオプションを使用してStratusのバケットから特定のオブジェクトをダウンロードできます。このSDKは、ダウンロード操作とともにロギング、ロード/バッファ画面のレンダリングなどの追加ファンクションを実行したい場合に最適です。 // オブジェクトのダウンロード中のプロセスコールバック const processCallback = () => { // オブジェクトの取得中に実行する関数 console.log("Downloading Object"); } const options = { 'versionId': 'djkshr8374yiuhf48' } const getObject = await bucket.getObject("key", options, processCallback); const getObjectStart = getObject.start(); // リクエストを開始する const getObjectAbort = getObject.abort(); // リクエストを中止する **レスポンス例** { "status": 200, "content": {Blob Data}, "message": "OK" } **想定される例外** * **404**: オブジェクトまたはBucketが見つかりません * **416**: リクエストされた範囲が満たせません ### オブジェクトの特定部分のダウンロード このセクションでは、Stratusからローカルシステムにオブジェクトの必要なバイト範囲をダウンロードできるSDKメソッドについて説明します。以下のコードスニペットで使用されているStratusリファレンスは、コンポーネントインスタンスです。 このメソッドは、オブジェクトの開始バイトと終了バイトの範囲を使用して、オブジェクトを複数のバイト範囲に分割する方式で機能します。 const processCallback = () => { // オブジェクトの取得中に実行する関数 console.log("Downloading Object"); } const options = { 'range': '0-2000' // オブジェクトのバイト単位の開始・終了範囲 } const getObject = await stratus.getObject("key", options, processCallback); const getObjectStart = getObject.start(); // リクエストを開始する const getObjectAbort = getObject.abort(); // リクエストを中止する **レスポンス例** { "status": 206, "content": {Blob Data}, "message": "PARTIAL_CONTENT" } ### 署名付きURLを使用したオブジェクトのダウンロード #### 非同期ファンクションの使用 // 署名付きURLを使用したオブジェクトのダウンロード // 非同期ファンクションの使用 const processCallback = () => { // オブジェクトの取得中に実行する関数 console.log("Downloading Object"); } const options = { 'range': '0-2000' // オブジェクトのバイト単位の開始・終了範囲, 'signed': true, // 署名付きURLを使用してバケットからオブジェクトを取得することを宣言する 'signedUrlFn' : async (functionData) => { console.log("Data : " + functionData); // ファンクションロジック return { "signed_url": "" //署名付きURL } } } const getObject = await stratus.getObject("key", options, processCallback); const getObjectStart = getObject.start(); // リクエストを開始する const getObjectAbort = getObject.abort(); // リクエストを中止する #### Promiseの使用 // Promiseの使用 const processCallback = () => { // オブジェクトの取得中に実行する関数 console.log("Downloading Object"); } const options = { 'range': '0-2000' // オブジェクトのバイト単位の開始・終了範囲, 'signed': true, // 署名付きURLを使用してバケットからオブジェクトを取得することを宣言する 'signedUrlFn' : (functionData) => { return new Promise((resolve, reject) => { console.log("Data : " + functionData); // ファンクションロジック resolve({ "signed_url" : "" }) }) } } const getObject = await stratus.getObject("key", options, processCallback); const getObjectStart = getObject.start(); // リクエストを開始する const getObjectAbort = getObject.abort(); // リクエストを中止する #### オプション付きSignedURLの使用 以下のSDKメソッドを使用すると、署名付きURLを使用してオブジェクトをダウンロードし、署名付きURLの**有効期限**を設定できます。 // 署名付きURLと有効期限を使用したオブジェクトのダウンロード const processCallback = () => { // オブジェクトの取得中に実行する関数 console.log("Downloading Object"); } const options = { 'range': '0-2000' // オブジェクトのバイト単位の開始・終了範囲, 'signed': true, // 署名付きURLを使用してバケットからオブジェクトを取得することを宣言する 'signedUrlFn' : async (functionData) => { console.log("Data : " + functionData); // ファンクションロジック return { "signed_url": "" // 署名付きURL } }, "expiryInSeconds" : 3000 // 秒単位 } const getObject = await stratus.getObject("key", options, processCallback); const getObjectStart = getObject.start(); // リクエストを開始する const getObjectAbort = getObject.abort(); // リクエストを中止する ### キャッシュURLを使用したキャッシュオブジェクトのダウンロード 以下のSDKメソッドを使用すると、キャッシュURLを使用してキャッシュオブジェクトをダウンロードできます。 // キャッシュURL const processCallback = () => { // オブジェクトの取得中に実行する関数 console.log("Downloading Object"); } const options = { 'range': '0-2000' // オブジェクトのバイト単位の開始・終了範囲, 'cached': true, // キャッシュURLを使用してバケットからオブジェクトを取得することを宣言する } const getObject = await stratus.getObject("key", options, processCallback); const getObjectStart = getObject.start(); // リクエストを開始する const getObjectAbort = getObject.abort(); // リクエストを中止する -------------------------------------------------------------------------------- title: "オブジェクトのアップロード" description: "このページでは、バケットにオブジェクトをアップロードするためのWeb SDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.370Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/stratus/upload-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Upload Object Help Documentation (/ja/cloud-scale/help/stratus/objects/upload-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/upload-object/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/upload-object/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/upload-object/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/upload-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/upload-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/upload-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトのアップロード このセクションに記載されているSDKメソッドを使用すると、バケットにオブジェクトをアップロードできます。以下のコードスニペットで使用されているStratusリファレンスは、コンポーネントインスタンスです。 オブジェクトに対してバージョニングが有効になっていない場合、Stratusが同じオブジェクトに対して複数の書き込みリクエストを受信すると、オブジェクトは継続的に上書きされます。最新のアップロードのみがバケットに保存されます。 ただし、バージョニングが有効な場合、各アップロードはオブジェクトのバージョンとして扱われ、それぞれ一意のversionIdを持ってバケットに保存されます。 注意: パスまたはオブジェクトを作成する際に、スペースを含む以下の文字はサポートされていません：ダブルクォート、両方の山括弧、ハッシュタグ、バックスラッシュ、パイプ記号。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトのパスを含む完全な名前を保持します。</td> </tr> <tr> <td>File</td> <td>File | String</td> <td>必須パラメータです。アップロードするオブジェクトです。</td> </tr> <tr> <td>options <td>JSON Object</td> <td> <ul> <li>overwrite: オプションのStringパラメータです。 <ul> <li>バケットのバージョニングが有効になっていない場合、リソースを上書きするにはこのオプションを使用する必要があります。</li> <li>デフォルト値: false</li> </ul> </li> <li>ttl: オプションのString | Numberパラメータです。 <ul> <li>オブジェクトのTime-to-Live（ttl）を秒単位で設定できます。</li> <li>値は60秒以上である必要があります。</li> </ul> </li> <li>type: オプションのStringパラメータです。 <ul> <li>このパラメータを使用して、オブジェクトのcontent-typeを上書きできます。</li> <li>このパラメータを渡さない場合、デフォルトでtypeの値はapplication/octet-streamになります。</li> </ul> </li> <li>meta: オプションのJSON Objectパラメータです。バケットにアップロードされるオブジェクトのメタ情報を追加するために使用されます。デフォルト値は空のJSONオブジェクトです。 </li> </ul> </td> <tr> <td>processCallback</td> <td>Function</td> <td>ファイルダウンロード中のコールバック関数です。</td> </tr> </tbody> </table> ### ファイルとしてオブジェクトをアップロード 以下のSDKメソッドを使用すると、Stratusのバケットにオブジェクトファイルをアップロードできます。 // ファイルとしてオブジェクトをアップロード const file = document.getElementById("uploadedFiles").files[0] const putObject = await bucket.putObject("key", file); const putObjectStart = putObject.start(); // リクエストを開始する const putObjectAbort = putObject.abort(); // リクエストを中止する ### 文字列としてオブジェクトをアップロード 以下のSDKメソッドを使用すると、Stratusのバケットに文字列オブジェクトをアップロードできます。 // 文字列としてオブジェクトをアップロード const putObject = await bucket.putObject("key", "Content of the file"); const putObjectStart = putObject.start(); // リクエストを開始する const putObjectAbort = putObject.abort(); // リクエストを中止する ### オプション付きでオブジェクトをアップロード 以下のSDKメソッドを使用すると、Stratusのバケットに任意のオブジェクトをアップロードできます。このSDKメソッドでは、optionsパラメータを使用してtype、overwrite、およびttlの指示を提供できます。 // オプション付きでオブジェクトをアップロード const options = { "overwrite": true, //既存のオブジェクトを上書きする "ttl": 300, //300秒後にオブジェクトがバケットから削除される "type": "text/plain" // アップロードされるオブジェクトのファイルタイプ } const putObject = await bucket.putObject("key", "Content of the file", options); const putObjectStart = putObject.start(); // リクエストを開始する const putObjectAbort = putObject.abort(); // リクエストを中止する ### プロセスコールバック付きでオブジェクトをアップロード 以下のSDKスニペットを使用すると、プロセスコールバックオプション付きでStratusのバケットに特定のオブジェクトをアップロードできます。このSDKは、アップロード操作と並行してログ記録、ロード/バッファ画面のレンダリングなどの追加機能を実行したい場合に最適です。 // オブジェクトのアップロード中に関数を実行する const processCallback = () => { // オブジェクトのアップロード中に実行する関数 console.log("Uploading Object"); } const options = { "overwrite": true, "ttl": 300, "type": "text/plain" } const putObject = await bucket.putObject("key", "Content of the file", options, processCallback); const putObjectStart = putObject.start(); // リクエストを開始する const putObjectAbort = putObject.abort(); // リクエストを中止する ### メタデータ付きでオブジェクトをアップロード 以下のSDKスニペットを使用すると、Stratusのバケットに特定のオブジェクトをメタデータと共にアップロードできます。 // メタデータ付きでオブジェクトをアップロード const options = { "overwrite": true, "ttl": 300, "type": "text/plain" // アップロードするオブジェクトのファイルタイプ "meta": { "object_meta_key" : "object_meta_value" } } const putObject = await bucket.putObject("key", "Content of the file", options); const putObjectStart = putObject.start(); // リクエストを開始する const putObjectAbort = putObject.abort(); // リクエストを中止する **レスポンス例** { "status": 200, "content": true | false, //true: アップロード成功、false: アップロード失敗 "message": "OK" } ### マルチパートアップロード アップロードするオブジェクトが大きすぎる場合、マルチパート操作を実行できます。マルチパート操作はオブジェクトを複数のパートに分割し、より高速なアップロードを実行します。このSDKセクションでは、Stratusのオブジェクトのマルチパートアップロードを実行するために使用できるすべてのSDKメソッドについて説明します。 #### マルチパートインスタンスの作成 マルチパート操作を実行するには、マルチパートオブジェクトインスタンスを取得する必要があります。このコンポーネントインスタンスは、Stratusのバケットに格納されたオブジェクトに対してマルチパート操作を実行するさまざまなコードスニペットで参照されます。以下のコードスニペットで使用されているBucketリファレンスは、コンポーネントインスタンスです。 const multipart = bucket.getMultipartInstance("key"); #### マルチパートアップロードの開始 **オプションなしでマルチパートアップロードを開始** 以下のSDKメソッドを使用すると、StratusはuploadIdを返します。このIDにより、オブジェクトの複数のパートをアップロードできます。 // アップロードを開始する const initiateUpload = await multipart.initiateUpload(); **オプション付きでマルチパートアップロードを開始** 以下のSDKメソッドを使用すると、StratusはuploadIdを返します。このIDにより、オブジェクトの複数のパートをアップロードできます。さらに、このSDKメソッドではoptionsパラメータを使用してtypeの指示を提供できます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>type</td> <td>String</td> <td> <ul> <li>このパラメータはoptions JSON Objectパラメータ内のキーです。 <li>このパラメータを使用して、オブジェクトのcontent-typeを上書きできます。</li> <li>このパラメータを渡さない場合、デフォルトでtypeの値はapplication/octet-streamになります。</li> </ul> </td> </tr> </tbody> </table> // オプション付きでアップロードを開始する const options = { type: "application/json" } const initiateUpload = await multipart.initiateUpload(options); **レスポンス例** { "status": 200, "content": { "bucket": "llm-development", "key": "a/cv", "upload_id": "01hyj639a9zfbg8j7q86nsrj6r" }, "message": "OK" } #### オブジェクトのパートをアップロード 以下のSDKメソッドでは、オブジェクトの個々のパートのアップロードを実行します。各パートには**1から1000**の範囲の個別のpart番号があります。これはパートの順序を表しますが、これらのパートは必ずしも順番にアップロードされるわけではありません。すべてのパートのアップロードが完了すると、これらのパートは順番に結合されます。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>file</td> <td>File</td> <td>アップロードするオブジェクトです。</td> </tr> <tr> <td>part</td> <td>Number</td> <td>アップロードされるパートの順序番号を含みます。</td> </tr> </tbody> </table> const partNumber = 1; const file = document.getElementById("uploadedFiles").files[0] const uploadPart = await multipart.uploadPart(file, partNumber) const uploadPartStart = uploadPart.start(); // リクエストを開始する const uploadPartAbort = uploadPart.abort(); // リクエストを中止する **レスポンス例** { "status": 200, "content": true | false, //true: アップロード成功、false: アップロード失敗 "message": "OK" } #### マルチパートアップロードの完了 以下のメソッドを使用すると、すべてのパートが正常にアップロードされた後にマルチパートプロセスを終了できます。 const completeUpload = await multipart.completeUpload() **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>options</td> <td>JSON Object</td> <td>meta: オプションのJSON Objectパラメータです。バケットにアップロードされるオブジェクトのメタ情報を追加するために使用されます。デフォルト値は空のJSONオブジェクトです。</td> </tr> </tbody> </table> **レスポンス例** { "status": 200, "content": true | false, //true: アップロード成功、false: アップロード失敗 "message": "OK" } #### アップロードサマリーの取得 以下のSDKメソッドを使用すると、アップロードされたすべてのパートの操作サマリーを取得できます。サマリーを表示するには、getUploadSummary()メソッドを使用します。 const getUploadSummary = await multipart.getUploadSummary(); **レスポンス例** { "bucket": "zcstratus12345-development", "key": "sasm.txt", "upload_id": "01hyfyeazrrstmt7k5fa7ej726", "status": "PENDING", "parts": [ { "part_number": 1, "size": 0, "uploaded_at": 1716374678999 }, { "part_number": 2, "size": 2797094, "uploaded_at": 1716374678576 }, { "part_number": 4, "size": 0, "uploaded_at": 1716374679136 } ] } ### すべてのマルチパート機能をラップしたオブジェクトのアップロード 以下のSDKメソッドはラッパーとして機能し、マルチパートアップロード操作全体を複数のステップを使用せずに実行します。このメソッドを使用すると、オブジェクトは複数のパートに分割され、複数のパートでバケットにアップロードされ、すべてのパートがアップロードされた後に結合されます。 ただし、以下のメソッドは次の条件でのみ使用することを推奨します： * オブジェクトのmax_part_sizeはファイル全体のサイズにすることができます。ただし、より高速なアップロードを確保するために、max_part_sizeは**100MB**以下にすることをお勧めします。 * オブジェクトのmin_part_sizeは**5MB**以上である必要があります。 * オブジェクト全体のサイズは**10GB**以下である必要があります。 注意: 10GBを超えるオブジェクトの場合は、マルチパートアップロード操作を正常に実行するために個別のSDKメソッドを使用することを推奨します。<br /> **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>file</td> <td>File</td> <td>アップロードするオブジェクトです。</td> </tr> <tr> <td>partSize</td> <td>Number</td> <td>アップロードされるオブジェクトの各パートのサイズを含みます。</td> </tr> <tr> <td>options</td> <td>JSON Object</td> <td> type: このJSONオブジェクト内のキーとなるパラメータです。 <ul> <li>Stringパラメータです。</li> このパラメータを使用して、オブジェクトのcontent-typeを上書きできます。</li> <li>このパラメータを渡さない場合、デフォルトでファイルの型が使用されます。ファイル自体に型がない場合、デフォルトでtypeの値はapplication/octet-streamになります。</li> <li>meta: オプションのJSON Objectパラメータです。バケットにアップロードされるオブジェクトのメタ情報を追加するために使用されます。デフォルト値は空のJSONオブジェクトです。 </li> </ul> </td> </tr> </tbody> </table> **オプションなしですべてのマルチパート機能をラップしたオブジェクトのアップロード** // オブジェクトをアップロード const partSize = 10; // MB単位 const file = document.getElementById("uploadedFiles").files[0] const uploadObject = await multipart.uploadObject(file, partSize); **オプション付きですべてのマルチパート機能をラップしたオブジェクトのアップロード** // オプション付きでオブジェクトをアップロード const partSize = 10; // MB単位 const file = document.getElementById("uploadedFiles").files[0] const options = { type: "application/json" // 上書きするオブジェクトのコンテンツタイプ } const uploadObject = await multipart.uploadObject(file, partSize, options); **レスポンス例** { "status": 200, "content": true | false, //true: アップロード成功、false: アップロード失敗 "message": "OK" } -------------------------------------------------------------------------------- title: "オブジェクトの削除" description: "このページでは、オブジェクトを削除するためのWeb SDKメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.370Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/stratus/delete-object/" service: "Cloud Scale" related: - Stratus Component Help Documentation (/ja/cloud-scale/help/stratus/introduction) - Delete an Object Help Documentation (/ja/cloud-scale/help/stratus/objects/manage-object/delete-object/) - Java SDK (/ja/sdk/java/v1/cloud-scale/stratus/delete-objects/) - Node.js SDK (/ja/sdk/nodejs/v2/cloud-scale/stratus/delete-objects/) - Python SDK (/ja/sdk/python/v1/cloud-scale/stratus/delete-objects/) - iOS SDK (/ja/sdk/ios/v2/cloud-scale/stratus/delete-object/) - Android SDK (/ja/sdk/android/v2/cloud-scale/stratus/delete-object/) - Flutter SDK (/ja/sdk/flutter/v2/cloud-scale/stratus/delete-object/) - REST API (/ja/api/code-reference/cloud-scale/stratus/get-all-buckets/#GetAllBuckets) -------------------------------------------------------------------------------- # オブジェクトの削除 このSDKメソッドを使用すると、deleteObject()メソッドにオブジェクトの完全な名前を渡すことで、特定のオブジェクトを削除できます。以下のコードスニペットで使用されているBucketリファレンスは、コンポーネントインスタンスです。 **使用パラメータ** <table class="content-table"> <thead> <tr> <th class="w20p">パラメータ名</th> <th class="w20p">データ型</th> <th class="w60p">定義</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>String</td> <td>必須パラメータです。オブジェクトのパスを含む完全な名前を保持します。</td> </tr> <tr> <td>options</td> <td>JSON Object</td> <td> <ul> <li>versionId: オプションのStringパラメータです。バケットでバージョニングが有効になっている場合、このパラメータにより一意のバージョンIDを使用して特定のバージョンを参照できます。 </li> <li>ttl: オプションのString | Numberパラメータです。オブジェクトのTime-to-Live（TTL）を秒単位で設定できます。値は60秒以上である必要があります。 </li> </ul> </td> </tr> </tbody> </table> ### オブジェクト名でオブジェクトを削除 以下のSDKメソッドを使用すると、対象のオブジェクトとそのすべてのバージョンをバケットから削除します。 // オブジェクトを削除する const deleteObject = await bucket.deleteObject("key"); ### オブジェクト名とバージョンIDでオブジェクトを削除 以下のSDKメソッドを使用すると、オブジェクトの特定のバージョンを削除します。 // TTL時間後にオブジェクトの特定バージョンを削除する const options = { versionId: "01hthq82gwxtfyz6d9j8eg6k2f", // 指定されたversionIdのオブジェクトを削除する ttl: 100 // 有効期限（秒単位） }; const deleteObject = await bucket.deleteObject("key", options); **レスポンス例** { "status": 200, "content": {}, "message": "Object deleted successfully." } **発生する可能性のある例外** * **404**: オブジェクトまたはバケットが見つかりません ##### ZCQL -------------------------------------------------------------------------------- title: "コンポーネントインスタンスの取得" description: "ZCQLは、Data Storeでデータ取得操作を実行できるCatalyst独自のクエリ言語です。" last_updated: "2026-06-10T06:04:54.370Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/zcql/get-component-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - ZCQL (/ja/cloud-scale/help/zcql/introduction/) - Execute ZCQL - API (/ja/api/code-reference/cloud-scale/zcql/execute-zcql-query/#ExecuteZCQLQuery) -------------------------------------------------------------------------------- # ZCQL ZCQLは、Catalyst Data Storeのテーブルに対してデータの取得、挿入、更新、削除操作を実行できるCatalyst独自のクエリ言語です。ZCQLを使用してさまざまなDMLクエリを実行し、データの取得や操作を行うことができます。また、SQL Joinクラス、GroupByおよびOrderByステートメント、組み込みSQLファンクションなど、さまざまなクローズやステートメントを使用できます。 ### コンポーネントインスタンスの取得 zcql リファレンスは、以下のように作成できます。これはサーバーサイドの呼び出しを発生させません。 //ZCQLインスタンスを取得する var zcql = catalyst.ZCatalystQL; -------------------------------------------------------------------------------- title: "ZCQLクエリの実行" description: "ZCQLは、Data Storeでデータ取得操作を実行できるCatalyst独自のクエリ言語です。" last_updated: "2026-06-10T06:04:54.371Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/zcql/execute-zcql-query/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - ZCQL (/ja/cloud-scale/help/zcql/introduction/) - Execute ZCQL - API (/ja/api/code-reference/cloud-scale/zcql/execute-zcql-query/#ExecuteZCQLQuery) -------------------------------------------------------------------------------- # ZCQLクエリの実行 ### クエリの構築 実行する前に、必要なデータセットに対するZCQLクエリを構築する必要があります。サンプルのSELECTクエリを以下に示します: //実行するクエリを作成する var query = 'SELECT * FROM ShipmentData'; ### クエリの実行 上記の手順で作成したクエリオブジェクトをexecuteZCQLQuery()メソッドに渡します。ここで使用されているzcqlリファレンスは、先に定義したコンポーネントインスタンスです。 これはPromiseを返し、オブジェクトに解決されます。contentキーには行オブジェクトの配列が含まれます。 //クエリを渡して実行する var zcql = catalyst.ZCatalystQL; var zcqlPromise = zcql.executeQuery(query); zcqlPromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); Note: コードでZCQL V2コマンドを使用するには、こちらに記載されているCatalystメソッドと以下の値を使用して、適切な環境変数を設定してください:<br /> * Key: ZOHO_CATALYST_ZCQL_PARSER * Value: V2 受け取るサンプルレスポンスを以下に示します。レスポンスはWeb SDKの両方のバージョンで同じです。 [ { AlienCity: { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-13 13:49:19:475", CREATEDTIME: "2021-08-13 13:49:19:475", CityName: "Dallas", ROWID: "2136000000008508" } }, { AlienCity: { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-16 15:55:32:969", CREATEDTIME: "2021-08-16 15:55:32:969", CityName: "Houston", ROWID: "2136000000011002" } }, { AlienCity: { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-16 17:03:01:507", CREATEDTIME: "2021-08-16 16:29:10:499", CityName: "Austin", ROWID: "2136000000011011" } } ] ##### プッシュ通知 -------------------------------------------------------------------------------- title: "クライアントの登録" description: "このWeb SDKスクリプトを使用すると、CatalystのWebアプリケーションからプッシュ通知を受信するクライアントデバイスを登録できます。" last_updated: "2026-06-10T06:04:54.371Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/push-notifications/register-client/" service: "Cloud Scale" related: - Push Notifications (/ja/cloud-scale/help/push-notifications/introduction) - Push Notification - API (/ja/api/code-reference/cloud-scale/push-notifications/web/send-web-push-notifications/#SendWebPushNotifications) -------------------------------------------------------------------------------- # Webプッシュ通知を受信するクライアントの登録 enableNotification() メソッドは、Webアプリケーションからプッシュ通知を受信するクライアントを登録します。以下のコードスニペットで使用されている notification リファレンスは、先に作成したコンポーネントインスタンスです。 enableNotification() メソッドはPromiseを返し、オブジェクトに解決されます。Promiseの解決後、messagehandler を通じて通知メッセージを処理できます。 //クライアントを登録する var notification = catalyst.notification; notification.enableNotification().then((response) => { //メッセージ受信時のハンドラーを作成する catalyst.notification.messageHandler = (msg) => { //メッセージ生成時に実行するアクション } }); その後、Catalystコンソールから、またはこのAPIを通じて、登録されたクライアントにプッシュ通知を送信できます。 -------------------------------------------------------------------------------- title: "プッシュ通知" description: "Catalyst Web SDKを使用してプッシュ通知を作成できます。" last_updated: "2026-06-10T06:04:54.371Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/push-notifications/get-component-instance/" service: "Cloud Scale" related: - Mobile Device Management (/ja/cloud-scale/help/mobile-device-management/introduction) - Push Notifications (/ja/cloud-scale/help/push-notifications/introduction) - Push Notification - API (/ja/api/code-reference/cloud-scale/push-notifications/web/enable-web-push-notifications/#EnableWebNotification) -------------------------------------------------------------------------------- # Push Notifications プッシュ通知は、アプリケーションがユーザーデバイスでアクティブに実行されていなくても、アプリケーションプロバイダーがアプリケーションのユーザーに送信できるリモート通知です。Catalystは、CatalystのWebおよびiOSアプリケーションにプッシュ通知を簡単に統合する方法を提供します。 ### コンポーネントインスタンスの取得 notification インスタンスは、以下のように作成できます。 Note: ここで返されるPromiseは、content キーに実行されたファンクションの出力を含むオブジェクトに解決されます。 // 通知インスタンスを取得する var notification = catalyst.notification; ##### 検索 -------------------------------------------------------------------------------- title: "コンポーネントインスタンスの取得" description: "Catalyst Web SDKを使用して検索オブジェクトを作成できます。" last_updated: "2026-06-10T06:04:54.371Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/search/get-component-instance/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Search (/ja/cloud-scale/help/search-integration/introduction) - Search - API (/ja/api/code-reference/cloud-scale/search/execute-search-query/#ExecuteSearchQuery) -------------------------------------------------------------------------------- # Search ### インデックス付きカラムのデータ検索 検索プロセスは、テーブルのインデックス付きカラムを検索する際に検索するパターンを指定します。以下を検索できます: * 複数テーブルのデータ * 検索インデックス付きカラムのデータのみ 検索の詳細については、こちらの情報をご参照ください。 ### コンポーネントインスタンスの取得 検索オブジェクトは、以下のメソッドを使用して作成できます。このメソッドはサーバーサイドの呼び出しを発生させません。 //検索オブジェクトを取得する var search = catalyst.search; -------------------------------------------------------------------------------- title: "データの検索" description: "Catalyst Web SDKを使用して、特定のデータパターンを検索するメソッドを実行できます。" last_updated: "2026-06-10T06:04:54.371Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/search/search-data/" service: "Cloud Scale" related: - Data Store (/ja/cloud-scale/help/data-store/introduction) - Search (/ja/cloud-scale/help/search-integration/introduction) - Search - API (/ja/api/code-reference/cloud-scale/search/execute-search-query/#ExecuteSearchQuery) -------------------------------------------------------------------------------- # データの検索 Searchは、特定のデータパターンを検索するために searchQuery() メソッドを実行します。コードスニペットで使用されているsearchは、コンポーネントインスタンスです。 ### 検索設定（JSON）の作成 以下のコードスニペットは、個々のテーブルのインデックス付きカラムで検索するパターンの属性を含むJSONオブジェクトを作成します。 //検索に使用するクエリオブジェクトを作成する //検索キーには検索するパターンが含まれる //search_table_columnsはテーブル名をキー、検索する列の配列を値として持つJSONオブジェクトです。 var QUERY = { "search": "santh*", "search_table_columns": { "customerDetails" : ["indexC1"], "SampleTable" : ["indexC2"] } }; ### 検索の実行 前のセクションで作成したJSONオブジェクトは、Promiseを返す searchQuery() メソッドのパラメータとして渡されます。 Note : 返されるPromiseは、contentキーにテーブル名をキーとし、行の配列を値とする検索結果を含むオブジェクトに解決されます。 //クエリオブジェクトを渡してテーブルを検索し、Promiseを返す var search = catalyst.search; var searchPromise = search.searchQuery(QUERY); searchPromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); 受け取るサンプルレスポンスを以下に示します。レスポンスはWeb SDKの両方のバージョンで同じです。 { AlienCity: [ { CREATORID: "2136000000006003", MODIFIEDTIME: "2021-08-13 13:49:19:475", CityName: "Dallas", CREATEDTIME: "2021-08-13 13:49:19:475", ROWID: "2136000000008508" } ] } ##### 認証 -------------------------------------------------------------------------------- title: "認証インスタンスの取得" description: "このページでは、Webアプリケーションで認証インスタンスを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.371Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/authentication/get-auth-instance/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # 認証インスタンスの取得 auth リファレンスを作成して、サインインおよびサインアウト操作を実行できます。以下のメソッドはこの目的で使用され、サーバーサイドの呼び出しは発生しません: //Get an Auth instance var auth = catalyst.auth; -------------------------------------------------------------------------------- title: "コンポーネントインスタンスの取得" description: "このページでは、Webアプリケーションでコンポーネントインスタンスを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.371Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/authentication/get-comp-instance/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # コンポーネントインスタンスの取得 userManagement リファレンスは、以下のメソッドを使用して作成できます。このメソッドはサーバーサイドの呼び出しを発生させません。 //Get an UserManagement Instance var userManagement = catalyst.userManagement; -------------------------------------------------------------------------------- title: "新しいユーザーの追加" description: "このページでは、Webアプリケーションに新しいユーザーアカウントを追加するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.371Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/authentication/add-new-user/" service: "Cloud Scale" related: - Get Authentication Instance - Web SDK (/ja/sdk/web/v4/cloud-scale/authentication/get-auth-instance) - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # 新しいユーザーの追加 Catalystサーバーレスアプリケーションにエンドユーザーを追加し、その詳細を取得し、アカウントを簡単に管理できます。 ユーザーがCatalystアプリケーションにサインアップすると、ZUID や userID などの一意の識別値が作成されます。また、ユーザーはCatalystによって組織に割り当てられます。詳細については、ユーザーヘルプページをご覧ください。 以下のコードスニペットを使用して、Catalystアプリケーションにアクセスする新しいユーザーを登録できます。この登録プロセスは、signUp() メソッドを使用して処理されます。以下のコードスニペットで使用されている auth リファレンスは、認証インスタンスページで定義されています。ユーザーを追加する際には、メールアドレスと姓の入力が必須です。 Note: 開発環境では、アプリケーションに追加できるユーザーは25人までです。アプリケーションを本番環境にデプロイした後は、任意の数のエンドユーザーを追加できます。 特定のユーザーの登録詳細を含むJSONオブジェクトは、以下のように作成します。 //Enter the first name, last name, email id, platform and the redirect url var data = { "first_name": "Jason", "last_name": "Chang", "email_id": "jason.c@zylker.com", "platform_type": "web", "redirect_url": "https://shipmenttracking.zylker.com/" }; このオブジェクトは、signUp() メソッドの引数として渡されます。ここで返されるPromiseは、contentキーに登録されたユーザーの詳細を含むオブジェクトに解決されます。 //Register the user by passing the object This in turn returns a promise var auth = catalyst.auth; var signupPromise = auth.signUp(data); signupPromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); 各バージョンで受け取るサンプルレスポンスを以下に示します: { zaid: "1005634498", user_details: { zuid: "1005641290", zaaid: "1005641456", org_id: "1005641456", status: "ACTIVE", is_confirmed: false, email_id: "p.boylie@zylker.com", first_name: "loki", last_name: "Boyle", created_time: "Aug 12, 2021 12:33 PM", modified_time: "Aug 12, 2021 12:33 PM", invited_time: "Aug 12, 2021 12:33 PM", role_details: { role_name: "App User", role_id: "10103000000115016" }, user_type: "App User", source: "Email", user_id: "10103000000111308" }, redirect_url: "https://aliencity-66446133.development.catalystserverless.com/app/", platform_type": "web", org_id: "10062221186" } { zaid: 1005634498, user_details: { zuid: 1005641433, zaaid: 1005641434, org_id: 1005641434, status: "ACTIVE", is_confirmed: false, email_id: "p.boyle@zylker.com", last_name: "Boyle", created_time: "Aug 12, 2021 12:27 PM", modified_time: "Aug 12, 2021 12:27 PM", invited_time: "Aug 12, 2021 12:27 PM", role_details: { role_name: "App User", role_id: 2305000000006024 }, user_type: "App User", user_id: 2305000000007745, project_profiles: [] }, redirect_url: "https://aliencity-66446133.development.catalystserverless.com/app/", platform_type: "web", org_id: null } -------------------------------------------------------------------------------- title: "パスワードのリセット" description: "このページでは、Webアプリケーションでユーザーアカウントのパスワードをリセットするメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.371Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/authentication/reset-password/" service: "Cloud Scale" related: - Get Component Instance - Web SDK (/ja/sdk/web/v4/cloud-scale/authentication/get-comp-instance) - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # パスワードのリセット ユーザーが正常に登録された後、以下のコードスニペットを使用してパスワードをリセットできます。 forgotPassword() メソッドが呼び出されると、パスワードリセットリンクが生成され、ユーザーのメールアドレスに送信されます。 ユーザーのメールアドレスのみが必須属性です。以下のコードスニペットで使用されている userManagement リファレンスは、コンポーネントインスタンスです。 特定のユーザーの登録詳細を含むJSONオブジェクトは、以下のように作成します: //Create an object with the details such as email Id, platform and redirect url var data = { "email_id": "amelia.burrows@zylker.com", "platform_type": "web", "redirect_url": "https://catalyst.zoho.com" }; このオブジェクトは、forgotPassword() メソッドの引数として渡されます。 Note : 返されるPromiseは、contentキーに確認メッセージを含むオブジェクトに解決されます。 //Reset password by passing the details. This in turn returns a promise. var userManagement = catalyst.userManagement; var forgotPromise = userManagement.forgotPassword(data); forgotPromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); -------------------------------------------------------------------------------- title: "新しいパスワードの設定" description: "このページでは、ユーザーが認証によるログインプロセスを完了した後にパスワードを設定するメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.371Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/authentication/set-new-password/" service: "Cloud Scale" related: - Get Component Instance - Web SDK (/ja/sdk/web/v4/cloud-scale/authentication/get-comp-instance) - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- このSDKスニペットを使用すると、エンドユーザーがアプリケーションにログインした後にパスワードをリセットできます。パスワードを変更するには、oldPassword の入力が必須です。以下のコードスニペットで使用されている auth リファレンスは、認証インスタンスページで定義されています。 catalyst.auth.changePassword(oldPassword,newPassword) Note: このSDKスニペットは、Web SDK 4.3.0をインストールした場合にのみ使用できます。 -------------------------------------------------------------------------------- title: "ユーザーオブジェクトの取得" description: "このページでは、Webアプリケーションでユーザーオブジェクトインスタンスを取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.371Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/authentication/get-user-object/" service: "Cloud Scale" related: - Get Component Instance - Web SDK (/ja/sdk/web/v4/cloud-scale/authentication/get-comp-instance) - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # ユーザーオブジェクトの取得 user オブジェクトは、以下のメソッドを使用して作成できます。このメソッドはサーバーサイドの呼び出しを発生させません。以下のコードスニペットで使用されている userManagement リファレンスは、コンポーネントインスタンスです。 //Get the user object passing the user id. var userManagement = catalyst.userManagement; var user = userManagement.userId(USER_ID); -------------------------------------------------------------------------------- title: "ユーザー詳細の取得" description: "このページでは、Webアプリケーションでユーザーアカウントの詳細を取得するメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.371Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/authentication/get-user-details/" service: "Cloud Scale" related: - Get Component Instance - Web SDK (/ja/sdk/web/v4/cloud-scale/authentication/get-comp-instance) - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # ユーザー詳細の取得 Catalyst認証は、アプリケーションユーザーの詳細を取得するためのいくつかのメソッドを提供します。現在のユーザー、任意のユーザー、またはアプリケーションの全ユーザーの情報を取得できます。 ### 現在のユーザー詳細の取得 getCurrentProjectUser() メソッドは、ファンクションが実行されているスコープのユーザーの詳細を取得します。コードスニペットで使用されている userManagement リファレンスは、先に作成したコンポーネントインスタンスです。 ここで返されるPromiseは、contentキーに現在のアプリケーションユーザーの詳細を含むオブジェクトに解決されます。 //Get the details of the current user var userManagement = catalyst.userManagement; var currentUserPromise = userManagement.getCurrentProjectUser(); currentUserPromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); また、getCurrentProjectUser() メソッドの代替として、isUserAuthenticated() メソッドも使用できます。 //Get the details of the current user var userManagement = catalyst.auth; var currentUserPromise = userManagement.isUserAuthenticated(); currentUserPromise .then((response) => { console.log(response.content); }) .catch((err) => { console.log(err); }); 各バージョンで受け取るサンプルレスポンスを以下に示します: { zuid: "10062169698", zaaid: "10062169862", org_id: "10062169862", status: "ACTIVE", is_confirmed: false, email_id: "amelia.burrows@zylker.com", first_name: "Amelia", last_name: "Burrows", created_time: "Jul 05, 2023 10:30 AM", modified_time: "Jul 05, 2023 10:30 AM", invited_time: "Jul 05, 2023 10:30 AM", role_details: { role_name: "App Administrator", role_id: "10103000000115014" }, user_type: "App User", user_id: "10103000000115057", locale: "us|en_us|America/Los_Angeles", time_zone: "America/Los_Angeles" } { zuid: 1005641433, zaaid: 1005641434, org_id: 1005641434, status: "ACTIVE", is_confirmed: false, email_id: "p.boyle@zylker.com", last_name: "Boyle", created_time: "Aug 12, 2021 12:27 PM", role_details: { role_name: "App User", role_id: 2305000000006024 }, user_type: "App User", user_id: 2305000000007745, locale: "us|en|Asia/Kolkata", time_zone: "Asia/Kolkata", project_profiles: [] } -------------------------------------------------------------------------------- title: "サードパーティ認証" description: "このページでは、Catalystアプリケーションでサードパーティ認証を有効にするために必要なメソッドについて説明します。" last_updated: "2026-06-10T06:04:54.371Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/authentication/third-party-custom-token/" service: "Cloud Scale" related: - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # サードパーティ認証 Cloud Scaleの認証コンポーネントを使用すると、Catalystアプリケーションに任意のサードパーティ認証サービスを実装できます。エンドユーザーの認可と検証はサードパーティサービスによって処理され、データはCatalystに渡されます。 サードパーティ認証をCatalystアプリケーションに関連付ける前に、外部サービスでのサードパーティロジックの処理を完了していることを確認する必要があります。任意のサードパーティで認証を設定できます。 Note: サードパーティ認証サービスを実装するため、アプリケーションのセキュリティインフラストラクチャは、選択したサードパーティサービスの効率性に依存することをご理解ください。 次に、Catalystコンソールの*Cloud Scale*内の認証コンポーネントに移動して、Catalystで設定したサードパーティ認証をセットアップします。手順はCatalystヘルプページのサードパーティ認証のセットアップで説明されています。 このプロセスには、以下の手順を実行する必要があります: ### カスタムサーバートークンの生成 まず、カスタムサーバートークンを生成します。ユーザーが認証後にサードパーティサービスからリダイレクトされると、そのユーザーの認証情報を、Java、Node.js、またはPythonでコーディングする認証ファンクションに渡す必要があります。このファンクションは、Catalystサーバーサイドトークン **JSON Web Token** トークン（JWT）を生成し、クライアントに渡されます。 Note: Catalystアプリケーションでサードパーティ認証を有効にするには、コンソールでPublic Signupを有効にしていることを確認してください。 ### JWTを使用したユーザー認証 以下のSDKは、生成されたJWTまたはカスタムトークンを使用してエンドユーザーを認証します。サードパーティ認証を有効にするには、このコードをWebクライアントロジックに組み込む必要があります。 以下は、JWTを使用してユーザーを認証するサンプルコードです。 &lt;script src="https://static.zohocdn.com/catalyst/sdk/js/4.0.0/catalystWebSDK.js"&gt;&lt;/script&gt; &lt;script src="/__catalyst/sdk/init.js"&gt;&lt;/script&gt; &lt;script&gt; catalyst.auth.signinWithJwt(getCustomTokenCallback); function getCustomTokenCallback(){ return fetch("{domain}/server/{function_name}/execute") //生成されたカスタムトークンを取得する関数URL .then(resp => resp.json() .then(resp => { return new Promise((resolve, reject) => { resolve({ client_id : "********", scopes : "ZOHOCATALYST.tables.rows.ALL,ZOHOCATALYST.cache.READ", jwt_token : "*********" }); }); })) } &lt;/script&gt; Note: カスタムサーバートークンは、ユーザーがサードパーティ認証サービスを使用してアプリケーションにログインするたびに生成する必要があります。 ### 追加設定の構成 最後に、*Whitelisting*の一部としてCustomer User ValidationまたはAuthorized Domainsを設定し、セットアップを完了します。Catalystは、サードパーティ認証サービスが有効化され、アプリケーションの認証がそのサービスによって処理されていることの確認を表示します。 -------------------------------------------------------------------------------- title: "アプリケーションからのユーザーサインアウト" description: "このページでは、Webアプリケーションからユーザーアカウントをサインアウトするメソッドについて、サンプルコードスニペットとともに説明します。" last_updated: "2026-06-10T06:04:54.372Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/authentication/sign-out-user/" service: "Cloud Scale" related: - Get Authentication Instance - Web SDK (/ja/sdk/web/v4/cloud-scale/authentication/get-auth-instance) - Authentication (/ja/cloud-scale/help/authentication/introduction) -------------------------------------------------------------------------------- # アプリケーションからのユーザーサインアウト ユーザーは、リダイレクトURLを引数として渡す signOut() メソッドを使用してアプリケーションからログアウトできます。以下のコードスニペットで使用されている auth リファレンスは、認証インスタンスです。 Note : このメソッドはPromiseを返しません。 //Configure the redirect url after successful logout var redirectURL = "https://catalyst.zoho.com"; //リダイレクトURLを使用してサインアウトメソッドを呼び出す var auth = catalyst.auth; auth.signOut(redirectURL); -------------------------------------------------------------------------------- title: "クロスドメインアクセス" description: "このページでは、バックエンドサービスとフロントエンドサービスが異なるドメインでホストされている場合の認証メソッドについて説明します。" last_updated: "2026-06-10T06:04:54.372Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/cloud-scale/authentication/cross-domain-access/" service: "Cloud Scale" related: - Get Authentication Instance - Web SDK (/ja/sdk/web/v4/cloud-scale/authentication/get-auth-instance) - Authentication (/ja/cloud-scale/help/authentication/introduction) - Cross Domain Access Help Doc (/ja/cloud-scale/help/authentication/cross-domain-access/) -------------------------------------------------------------------------------- # フロントエンドサービスのバックエンド要件の認証 generateAuthToken() SDKメソッドは、バックエンドサービスとフロントエンドサービスが異なるドメインでホストされている場合に、フロントエンドサービスから行われるバックエンド呼び出しを検証するために必要なトークンを生成します。 Notes:<br /> * バックエンドサービスとフロントエンドサービスは異なるホスティングサービスでホストされていても、同じCatalystプロジェクトの一部である必要があります。 * Catalyst認証のCORS機能を使用して、バックエンドサービスとフロントエンドサービスのドメインをホワイトリストに登録していることを確認してください。CORS機能の詳細については、このヘルプドキュメントをご覧ください。 * generateAuthToken() SDKメソッドは、Web SDKバージョンv4.6.1から使用できます。 var auth = catalyst.auth; auth.generateAuthToken().then((response) => { const token = response.access_token; // 必要なユーザートークンがレスポンスの値として共有されます }); #### Serverless ##### ファンクション -------------------------------------------------------------------------------- title: "コンポーネントインスタンスの取得" description: "Catalyst Functionsを使用すると、アプリケーションにカスタム機能を構築したり、タスクを自動化したり、サードパーティサービスと統合したりできます。" last_updated: "2026-06-10T06:04:54.372Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/serverless/functions/get-component-instance/" service: "Serverless" related: - Functions (/ja/serverless/help/functions/introduction) - Function - API (/ja/api/code-reference/serverless/functions/execute-function/#ExecuteFunction) -------------------------------------------------------------------------------- # Functions CatalystのFunctionグループは、Catalystのオンラインエディタまたはコマンドラインインターフェース（CLI）を通じて作成および定義されます。Functionグループ内のFunctionは、テスト環境および本番環境で実行できます。 ### コンポーネントインスタンスの取得 以下のメソッドを使用してFunctionsの参照を作成できます。このメソッドはサーバーサイドの呼び出しを実行しません。 //Functionインスタンスを取得します var functions = catalyst.function; -------------------------------------------------------------------------------- title: "Functionオブジェクトの取得" description: "Catalyst Functionsを使用すると、アプリケーションにカスタム機能を構築したり、タスクを自動化したり、サードパーティサービスと統合したりできます。" last_updated: "2026-06-10T06:04:54.372Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/serverless/functions/get-function-object/" service: "Serverless" related: - Functions (/ja/serverless/help/functions/introduction) - Function - API (/ja/api/code-reference/serverless/functions/execute-function/#ExecuteFunction) -------------------------------------------------------------------------------- # Functionオブジェクトの取得 以下のメソッドを使用してFunctionオブジェクトを作成できます。このメソッドはサーバーサイドの呼び出しを実行しません。一意のFunction IDがメソッドのパラメータとして渡されます。以下のコードスニペットで使用されている**functions**は、コンポーネントインスタンスです。 //Function IDを渡してFunctionオブジェクトを取得します var functions = catalyst.function; var functionObject = functions.functionId(FUNCTION_ID); -------------------------------------------------------------------------------- title: "Functionの実行" description: "Catalyst Functionsを使用すると、アプリケーションにカスタム機能を構築したり、タスクを自動化したり、サードパーティサービスと統合したりできます。" last_updated: "2026-06-10T06:04:54.372Z" source: "https://docs.catalyst.zoho.com/ja/sdk/web/v4/serverless/functions/execute-function/" service: "Serverless" related: - Functions (/ja/serverless/help/functions/introduction) - Function - API (/ja/api/code-reference/serverless/functions/execute-function/#ExecuteFunction) -------------------------------------------------------------------------------- # Functionの実行 Functionは、設定（JSON型）をパラメータとして渡すexecute()メソッドを呼び出すことで実行できます。コードスニペットで使用されている**function**オブジェクトは、Functionオブジェクトです。 ### Function設定の作成 Functionを実行する前に、必要な設定を行うことが必須です。ここでは、設定としてFunction引数（**args**として）がある場合にそれを指定します。 //Functionを実行するために使用する設定オブジェクトを作成します。 //argsはFunctionにパラメータとして値を渡すためのJSONObjectです。 var config = { "args": {"name": "xxx"}, "method":"GET" }; サポートされているHTTPメソッドは、GET、PUT、POST、PATCH、およびDELETEです。 GETがデフォルトです。コードでGETを使用する場合、Function引数はクエリ文字列として渡されます。その他のHTTPメソッドを使用する場合、Function引数はリクエストボディで渡されます。 ### Functionの実行 **configuration**オブジェクトを引数としてexecute()メソッドに渡すことで、Functionを実行できます。 ここで返されるPromiseは、実行されたFunctionの出力がcontentキーに含まれるオブジェクトに解決されます。 //設定オブジェクトを渡してFunctionを実行します var functions = catalyst.function; var functionObject = functions.functionId(FUNCTION_NAME); //Function IDまたはFunction名を引数として渡すことができます var functionPromise = functionObject.execute(config); functionPromise .then((response) => { response.json().then(responseBody => { console.log(responseBody); }); }) .catch((err) => { console.log(err); }); --- ## FAQ — Catalyst SDK # Catalyst SDK Catalystコンソールの2か所からCatalyst SDKにアクセスできます： 1. **プロジェクトページの展開メニューから**： Catalystコンソールでプロジェクトを開き、プロフィール画像をクリックします。展開メニューには、アプリケーションで使用できるさまざまなSDKをダウンロードするためのリンクが含まれています。 2. **設定のDeveloper Toolsから**： SettingsのDeveloper Toolsにも、プロジェクトで利用可能なSDKにアクセスしてダウンロードするためのリンクが含まれています。 SDKへのアクセスとコンソールの使用方法の詳細については、**Catalystコンソールヘルプページ**を参照してください。 getCurrentUser()メソッドを含むBasic I/OまたはAdvanced I/Oファンクションをトリガーする前にクライアントポータルが認証されていない場合、ファンクションは管理者認証を使用して実行されます。これにより、メソッドはnullレスポンスを返します。 そのため、getCurrentUser()メソッドを実行する前に、クライアントポータルを認証していることを確認する必要があります。 このエラーは、アカウントのデータセンター（DC）とは異なるDCの認証URLドメインでトークンを生成しようとした場合に発生します。アカウントと同じDCでグラントトークン（code）、refresh_token、access_tokenを生成していることを確認する必要があります。 このエラーは、グラントトークン（code）の生成時にPOST操作またはその他の操作の適切なスコープを含めていない場合に発生します。実行するすべての操作に必要なスコープを追加してグラントトークンを生成し、新しいトークンを操作に使用してください。 各ユーザーに一意のキー名を指定して、キャッシュセグメントに複数のユーザーのアクセストークンを保存できます。キャッシュに値が存在する場合、有効期限が切れるまで、以降のすべての呼び出しで同じアクセストークン値が返されます。有効期限が切れた後、コネクタは自動的に新しいアクセストークンを取得してキャッシュに保存します。Catalystコネクタを通じた複数ユーザーのアクセストークン処理ロジックの実装については、こちらのチュートリアルを参照してください。