--- title: "Flutter SDKの実装" url: https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/implement-flutter-sdk/ description: "AndroidまたはiOSでFlutterアプリの開発環境をセットアップした後、プロジェクトにFlutter SDKをインストール、インポート、および初期化する必要があります。" last_updated: 2026-02-23T12:39:41Z service: All Services type: general related_links: - name: "Environments" url: /ja/deployment-and-billing/environments/introduction/#introduction --- # プロジェクトへのFlutter SDKの実装 AndroidまたはiOSでFlutterアプリの開発環境をセットアップし、IDEでFlutterプロジェクトを作成した後、FlutterプロジェクトにCatalyst Flutter SDKを実装できます。 Flutterプロジェクトを作成すると、基本的な[`pubspec.yaml`](https://docs.flutter.dev/tools/pubspec)ファイルが生成され、プロジェクトツリーの最上位に配置されます。このファイルには、プロジェクトに関するメタデータとプロジェクトが必要とする依存関係が含まれています。 ### SDKのインストール Catalyst Flutter SDKを実装するには、Flutterプロジェクトの`pubspec.yaml`に以下の設定を追加する必要があります： ```bash dependencies: zcatalyst_sdk: ^2.2.1 ``` プロジェクトにFlutter SDKをインストールするには、IDEのターミナルから以下のコマンドを実行する必要があります： ```bash flutter pub get ``` > **Note**: IDEで以下の方法でもこのパッケージを取得できます： * VS Code: `pubspec.yaml`の上部にあるアクションリボンの右側にある、ダウンロードアイコンで示された**Get Packages**をクリックします。 * Android Studio/IntelliJ: `pubspec.yaml`の上部にあるアクションリボンの**Pub get**をクリックします。 #### SDKをインストールする別の方法： 上記の`pubspec.yaml`ファイルに設定を追加する代わりに、FlutterプロジェクトのディレクトリでIDEのターミナルから以下のコマンドを直接実行して、Flutter SDKをインストールできます： ```bash flutter pub add zcatalyst_sdk ``` ### SDKのインポート DartコードでSDKをインポートするには、Flutterプロジェクトディレクトリの`lib`/`main.dart`ファイルに以下のコード行を追加する必要があります： ```bash import 'package:zcatalyst_sdk/zcatalyst_sdk.dart'; ``` ### SDKの初期化 SDKパッケージで定義されたメソッドと機能を有効にするために、Catalyst SDKを初期化する必要があります。 そのため、SDKメソッドを使用するようにアプリを設定する前に、以下のいずれかの方法で`main()`関数内の`ZCatalystApp.init()`メソッドを使用してSDKを初期化する必要があります： #### 1. Catalyst Configuration Fileを使用する方法： 以前に[Android](https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/setup-for-android/#step-1-register-your-android-app-with-catalyst)または[iOS](https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/setup-for-ios/#step-1-register-your-ios-app-with-catalyst)用にダウンロードした設定ファイルは、アプリの環境を示します。アプリのプロジェクトの[環境](https://docs.catalyst.zoho.com/ja/deployment-and-billing/environments/introduction)に基づいて適切な設定ファイル（Androidの場合は`app_configuration_development.properties` / `app_configuration_production.properties`、iOSの場合は`AppConfigurationDevelopment.plist` / `AppConfigurationProduction.plist`）を含めるのと同様に、適切な環境でSDKを初期化する必要があります。 **環境を指定する場合：** この方法では、必要な設定を行い、アプリの`environment`を`DEVELOPMENT`または`PRODUCTION`のいずれかに指定し、以下に示すように`ZCatalystApp`クラスの`init()`メソッドに渡します： ```bash ZCatalystApp.init({ ZCatalystEnvironment? environment, }); ``` サンプルコードスニペットを以下に示します： ```bash void main() async { try { await ZCatalystApp.init(environment: ZCatalystEnvironment.DEVELOPMENT); } on ZCatalystException catch (ex) { print('Initialized Failed: ${ex.toString()}'); } } ``` **環境を指定しない場合：** SDKの初期化時に`environment`が指定されない場合、デフォルトで`PRODUCTION`とみなされます。そのため、アプリがProduction環境で動作している場合は、以下の方法で直接SDKを初期化できます： ```bash await ZCatalystApp.init(); ``` サンプルコードスニペットを以下に示します： ```bash void main() async { try { await ZCatalystApp.init(); } on ZCatalystException catch (ex) { print('Initialized Failed: ${ex.toString()}'); } } ``` > **Note**: AndroidまたはiOSの設定ファイルに変更を加えた場合は、SDKを再初期化する必要があります。 #### 2. カスタムSDK Configurationオブジェクトを渡す方法： 別の方法として、`ZCatalystSDKConfigsBuilder`クラスを使用して渡せるカスタム`ZCatalystSDKConfigs`オブジェクトを構築して、Flutter SDKを初期化できます。 **ZCatalystSDKConfigsオブジェクト** `ZCatalystSDKConfigsBuilder`クラスには、以下の設定プロパティがあります：
プロパティ データ型 説明
`environment` `ZCatalystEnvironment` アプリが現在実行されている[環境](https://docs.catalyst.zoho.com/ja/deployment-and-billing/environments/introduction)です
`apiBaseURL` String 内部APIが呼び出されるCatalystサーバーのURLです。作業している環境に基づいて、適切なURL（[Development URL](https://docs.catalyst.zoho.com/ja/deployment-and-billing/environments/development-environment/#function-url-and-web-app-url-in-the-development-environment)または[Production URL](https://docs.catalyst.zoho.com/ja/deployment-and-billing/environments/production-environment/#function-url-and-web-app-url-in-the-production-environment)）を使用してください。
`clientID` String Catalystに登録されたアプリクライアントの一意の識別子です。設定ファイルで提供されます。
`clientSecret` String 特定の`clientID`に対して生成されたシークレット値で、APIリクエストとともに渡されます。設定ファイルで提供されます。
`projectID` int Catalystプロジェクトの[一意のID](https://docs.catalyst.zoho.com/ja/getting-started/set-up-a-catalyst-project/general-settings/)です
`redirectURL` String コンソールで[Android](https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/setup-for-android/)または[iOS](https://docs.catalyst.zoho.com/ja/sdk/flutter/v2/setup-for-ios/)用のパッケージを作成する際に指定した、アプリのコールバックURLです
`portalID` String AndroidまたはiOSアプリのセットアップ時に設定ファイルで提供される一意の識別子です
`oauthScopes` String プロジェクトからCatalyst APIにアクセスするためにアプリが使用するスコープです。利用可能なOAuthスコープは[こちら](https://docs.catalyst.zoho.com/ja/api/oauth2/scopes/#Scopes)で確認できます。
`JWTClientID` String クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントIDプロパティです
`JWTClientSecret` String クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントシークレットプロパティです
この`ZCatalystSDKConfigs`オブジェクトは、以下に示すように`ZCatalystSDKConfigsBuilder`クラスを使用して渡すことができます： ```bash 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が正常に初期化されると、アプリはコンポーネントメソッドを呼び出し、意図した通りに機能します。