セットアップ

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

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

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

1. プロジェクトのCatalystコンソールから設定アイコンをクリックします。

2. 設定メニューのProject Settingsの下にあるDeveloper Toolsに移動し、Androidタイルをクリックします。 または、下のAdd Packageボタンをクリックすることもできます。

3. 一意に識別するパッケージ名を入力します。アプリへのログイン後にエンドユーザーをリダイレクトするURLを、Redirect URLとして指定します。 ここで入力した値は、設定ファイルに自動入力されます。

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

5. コンソールに設定ファイルをダウンロードできるウィンドウが表示されます。Downloadをクリックしてファイルをダウンロードします。 必要なすべての設定が含まれたファイルがダウンロードされます。このファイルのプロパティについては、次のステップで説明します。

ステップ 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の公式ドキュメントを参照してください。

app_configuration_development.properties/ app_configuration_production.propertiesファイルのプロパティ

アプリ設定ファイルは、以下の表に記載されているプロパティを定義します。リクエストヘッダーを除くすべての値は、プロジェクトの詳細またはデフォルトの標準に基づいて自動的に入力されます。

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

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

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

maven {
		url "https://maven.zohodl.com/"
}

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

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

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

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

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

<string name="url_scheme">{redirection_url}</string>

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

このコードのredirection_urlの部分には、Catalystでアプリのパッケージを作成する際に設定したリダイレクトURLを渡す必要があります。

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

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

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

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

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/>

AndroidManifest.xmlファイルは、アプリの構造でapp/src/mainに移動すると見つけることができます。

Catalyst Android SDKを追加および実装するために必要なすべての設定が完了しました。上記のすべてのステップを実行した後、プロジェクトをビルドする必要があります。Gradleビルドが成功すると、アプリはCatalyst Android SDKのコンポーネントにアクセスできるようになります。

ステップ 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

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

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

ZCatalystApp.init(context: Context): ZCatalystApp

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