---
title: "セットアップ"
url: https://docs.catalyst.zoho.com/ja/sdk/android/v2/setup/
description: "CatalystプロジェクトとAndroidプロジェクトをセットアップするための手順です。"
last_updated: 2026-08-17T12:16:04Z
service: All Services
type: general
related_links:
  - name: "Environments"
    url: /ja/deployment-and-billing/environments/introduction/#introduction
  - name: "Developer Tools"
    url: /ja/deployment-and-billing/environments/introduction/#introduction
---

# セットアップ

CatalystプロジェクトとAndroidプロジェクトを作成した後、以下の手順に従ってAndroid SDKパッケージをアプリにセットアップおよび統合する必要があります。

### ステップ 1: CatalystにAndroidアプリを登録する

まず、CatalystでAndroidアプリのパッケージを作成して登録し、固有の設定ファイルをダウンロードします。

1. プロジェクトのCatalystコンソールから設定アイコンをクリックします。
![catalyst_console_settings](https://catalyst-docs-development.zohostratus.in/images/sdk/flutter/catalyst_console_settings.webp)

2. 設定メニューの*Project Settings*の下にある**Developer Tools**に移動し、**Android**タイルをクリックします。
![developer_tools_android_sdk](https://catalyst-docs-development.zohostratus.in/images/sdk/flutter/dev_tools_android_sdk.webp)または、下の**Add Package**ボタンをクリックすることもできます。

3. 一意に識別するパッケージ名を入力します。アプリへのログイン後にエンドユーザーをリダイレクトするURLを、Redirect URLとして指定します。
![android_sdk_create_package](https://catalyst-docs-development.zohostratus.in/images/sdk/flutter/dev_tools_android_sdk_package_1.webp)ここで入力した値は、設定ファイルに自動入力されます。

> **Note**: パッケージ名はそのOSに一意に関連付けられます。そのため、AndroidアプリとiOSアプリの両方に同じ名前のパッケージを作成することはできません。一意の値を指定する必要があります。

  OSタイプとしてAndroidが選択されていることを確認してください。

4. **Create**をクリックして、モバイルSDKパッケージを作成します。

5. コンソールに設定ファイルをダウンロードできるウィンドウが表示されます。**Download**をクリックしてファイルをダウンロードします。
![android_sdk_package_successful](https://catalyst-docs-development.zohostratus.in/images/sdk/flutter/dev_tools_android_sdk_package_2.webp)
必要なすべての設定が含まれたファイルがダウンロードされます。このファイルのプロパティについては、次のステップで説明します。

### ステップ 2: Androidプロジェクトに設定ファイルをインポートする

Catalystは、アプリケーションの開発とビルドのために2つの作業環境を提供しています：**Development**サンドボックスとライブの**Production**環境です。これらの詳細については、[環境のヘルプページ](https://docs.catalyst.zoho.com/ja/deployment-and-billing/environments/introduction)をご覧ください。

コンソールでパッケージを作成すると、現在作業している環境に関係なく、最初はDevelopment環境の設定ファイルのみがダウンロード可能になります。パッケージが作成された後は、いつでもコンソールから任意の環境の設定ファイルをダウンロードすることができます。

各環境の設定ファイルの名前は以下のとおりです：
* Development: `app_configuration_development.properties`
* Production: `app_configuration_production.properties`

作業中の環境に基づいて、適切なファイルをダウンロードしてAndroidアプリの構造に追加する必要があります。Production環境の設定ファイルを取得するには、まず[プロジェクトをProductionにデプロイ](https://docs.catalyst.zoho.com/ja/deployment-and-billing/environments/initial-deployment)してから、*Developer Tools*設定セクションから[ファイルをダウンロード](https://docs.catalyst.zoho.com/ja/getting-started/set-up-a-catalyst-project/developer-tools)する必要があります。

設定ファイルは、Androidアプリモジュールの`assets`ディレクトリに追加する必要があります。通常、`assets`フォルダは`app/src/main`ディレクトリに作成されます。
![android_sdk_android_studs](https://catalyst-docs-development.zohostratus.in/images/sdk/android/android_sdk_android_studs.webp)
Androidアプリモジュールの詳細については、[Androidの公式ドキュメント](https://developer.android.com/studio/projects)を参照してください。

#### 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](https://docs.catalyst.zoho.com/ja/getting-started/set-up-a-catalyst-project/general-settings/)です。</td>
</tr> 
<tr>
<td>`apiBaseURL`</td>
<td>String</td>
<td>内部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)）を使用する必要があります。</td>
</tr>
<tr>
<td>`oauthScopes`</td>
<td>String</td>
<td>プロジェクトからCatalyst APIにアクセスするためにアプリが使用するスコープです。利用可能なOAuthスコープは[こちら](https://docs.catalyst.zoho.com/ja/api/oauth2/scopes/#Scopes)で確認できます。</td>
</tr>
<tr>
<td>`requestHeaders`</td>
<td>String</td>
<td>HTTPリクエストでクライアントから送信されるヘッダーです。
 リクエストヘッダーの値は、個別のキーと値のペアをカンマで区切って指定します：`requestHeaders=`*key1:value1, key2:value2*</td>
</tr>
<tr>
<td>`serverTLD`</td>
<td>String</td>
<td>データサーバーのトップレベルドメインです。
 使用可能な値：`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>アプリのログ設定を行うことができます。
 使用可能な値：`warnings`, `errors`, `information`, `debug`, `ALL`</td>
</tr>
<tr>
<td>`httpRequestMode`</td>
<td>String</td>
<td>HTTPリクエストが同期か非同期かを定義します。
 使用可能な値：`SYNC`, `ASYNC`
 デフォルト値：`ASYNC`</td>
</tr>
<tr>
<td>`connectTimeOut
InSec`</td>
<td>Long</td>
<td>SDKから送信されるHTTPリクエストの接続タイムアウト値（秒単位）です。
 この時間内にサーバーからクライアントリクエストへのレスポンスが受信されない場合、接続は終了します。</td>
</tr>
<tr>
<td>`readTimeOutInSec`</td>
<td>Long</td>
<td>SDKから送信されるHTTPリクエストの読み取りタイムアウト値（秒単位）です。
 この時間内にサーバーからデータが受信されない場合、接続は終了します。</td>
</tr>
<tr>
<td>`writeTimeOutInSec`</td>
<td>Long</td>
<td>SDKから送信されるHTTPリクエストの書き込みタイムアウト値（秒単位）です。
 この時間内にリクエストデータのサーバーへの書き込みまたは送信に失敗した場合、接続は終了します。</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**:

* `clientID`、`clientSecret`、`projectID`、または`portalID`の値を設定ファイルで変更すると、SDKおよびAndroidアプリの動作に影響します。これらの設定を変更する場合は、Developer Toolsセクションから必要なプロジェクト用の[新しいパッケージを作成](https://docs.catalyst.zoho.com/ja/getting-started/set-up-a-catalyst-project/developer-tools/#create-a-mobile-sdk-package)し、適切な環境の新しい設定ファイルをダウンロードして、アプリの構造の`assets`ディレクトリに追加してください。

* ダウンロードした設定ファイルに入力されたプロパティの値は、`ZCatalystApp.configs`オブジェクトを使用して動的にアクセスできます。

### ステップ 3: アプリにCatalyst Android SDKを追加する

次のステップは、アプリにSDKパッケージを含めることです。Catalyst Android SDKはGradleライブラリとして利用可能です。ライブラリを含むMavenリポジトリにアクセスすることで、以下の方法でAndroidプロジェクトにSDKを追加できます：

1. Androidアプリ構造の**プロジェクトレベル**の`build.gradle`ファイルに、以下のコードスニペットを追加します：

```bash
maven {
		url "https<span></span>://maven.zohodl.com/"
}

```

2. Androidアプリ構造の**アプリレベル**の`build.gradle`ファイルに、以下のコードスニペットを追加します：

```bash
dependencies {
	    implementation 'com.zoho.catalyst:android-sdk:3.0.1'
}

```

### ステップ 4: アプリのログインリダイレクトを設定する

ユーザーがアプリに正常にログインすると、アプリのホーム画面にリダイレクトされます。このユーザーログインとリダイレクトはCatalyst SDKによって処理されます。

このリダイレクトが正しく処理されるようにするために、Androidアプリの`strings.xml`ファイルに以下の文字列を含めてください：

```bash
&lt;string name="url_scheme"&gt;{redirection_url}&lt;/string&gt;

```

`strings.xml`ファイルは、Androidプロジェクトを作成した際に自動的に作成されます。アプリの構造で`app/src/main/res/values`に移動すると見つけることができます。このファイルにはアプリ名の文字列定義がすでに含まれています。その文字列と一緒にこの文字列を含めてください。

このコードの`redirection_url`の部分には、Catalystでアプリの[パッケージを作成する際](https://docs.catalyst.zoho.com/ja/sdk/android/v2/setup/#step-1-register-your-android-app-with-catalyst)に設定した**リダイレクトURL**を渡す必要があります。

### ステップ 5: 必要な権限を設定する

Catalyst SDKでは、アプリがシームレスに機能し、スムーズなユーザーエクスペリエンスを提供するために、以下のアプリ権限を有効にする必要があります：

* `INTERNET`: Catalyst APIを実行するため
* `ACCESS_NETWORK_STATE`: ネットワーク障害を処理するため

これらの権限を有効にするには、以下のように`AndroidManifest.xml`ファイルで宣言する必要があります：

```bash
&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を追加および実装するために必要なすべての設定が完了しました。上記のすべてのステップを実行した後、[**プロジェクトをビルド**](https://developer.android.com/studio/run)する必要があります。Gradleビルドが成功すると、アプリはCatalyst Android SDKのコンポーネントにアクセスできるようになります。

### ステップ 6: SDKを初期化する

SDKパッケージで定義されているメソッドと機能を有効にするには、Catalyst SDKを初期化する必要があります。

したがって、SDKメソッドを使用するようにアプリを設定する前に、以下のいずれかの方法でSDKを初期化する必要があります：

#### 方法 1: 環境を指定する

`Environment`は、アプリがDevelopment環境またはProduction環境のどちらで動作しているかを示します。[環境](https://docs.catalyst.zoho.com/ja/deployment-and-billing/environments/introduction)に基づいてアプリのプロジェクトに適切な設定ファイル（`app_configuration_development.properties/ app_configuration_production.properties`）を含めるのと同様に、適切な環境用にSDKを初期化する必要があります。

この方法では、必要な設定を行い、アプリの`Environment`を`DEVELOPMENT`または`PRODUCTION`として指定し、以下のように`ZCatalystApp`クラスを通じて`init()`メソッドに渡します：

```bash
ZCatalystApp.init(
            context: Context,
            Environment: ZCatalystSDKConfigs.Environment.{DEVELOPMENT}
        ): ZCatalystApp

```

#### 方法 2: 環境を指定しない

SDK初期化時に`Environment`が指定されていない場合、デフォルトで`PRODUCTION`とみなされます。したがって、アプリがProduction環境で動作している場合は、以下のように`Environment`を指定せずに直接SDKを初期化できます：

```bash
ZCatalystApp.init(context: Context): ZCatalystApp
```

> **Note**: 
* `app_configuration_development.properties`または`app_configuration_production.properties`ファイルに変更を加えた場合は、SDKを再初期化する必要があります。

* Androidアプリにサードパーティ認証を設定した場合、この設定ファイルに新しいプロパティが追加されるため、SDKの再初期化も必要になります。詳細は[こちらのヘルプページ](https://docs.catalyst.zoho.com/ja/sdk/android/v2/cloud-scale/authentication/third-party-authentication/)をご覧ください。

SDKが正常に初期化されると、アプリはコンポーネントメソッドを呼び出し、意図したとおりに動作します。