Androidの開始手順

# Androidの開始手順

Flutter SDKを使用してAndroidをプライマリ開発ターゲットとしてFlutterモバイルアプリケーションを構築するには、CatalystでAndroidアプリの開発に必要な環境をセットアップする必要があります。

### 前提条件と最小サポート環境

Androidプラットフォームでのflutterアプリの作業を開始する前に、以下の前提条件を満たし、最小サポート環境を設定していることを確認してください：

* {{%link href="https://docs.flutter.dev/get-started/test-drive?tab=androidstudio"%}}Android Studioまたはサポートされている任意のIDEでFlutterプロジェクトを作成{{%/link%}}してください

* 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. 設定メニューの{{%italics%}}Project Settings{{%/italics%}}配下にある**Developer Tools**に移動し、**Android**タイルをクリックします。
または、下の**Add Package**ボタンをクリックすることもできます。

<br />

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

{{%note%}} {{%bold class="bold-primary"%}}Note{{%/bold%}}: パッケージ名はそのOSに一意に関連付けられます。そのため、AndroidアプリとiOSアプリの両方に同じ名前のパッケージを作成することはできません。一意の値を指定する必要があります。{{%/note%}}
  OSタイプとしてAndroidが選択されていることを確認してください。

<br />

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

5. コンソールに設定ファイルをダウンロードできるウィンドウが表示されます。**Download**をクリックしてファイルをダウンロードします。

必要なすべての設定が含まれたファイルがダウンロードされます。このファイルのプロパティについては、次のステップで説明します。

<br />

### ステップ2：AndroidプロジェクトにConfiguration Fileをインポートする

Catalystは、アプリケーションの開発およびビルド用に、**Development**サンドボックスとライブの**Production**環境の2つの作業環境を提供しています。詳細については、{{%link href="/ja/deployment-and-billing/environments/introduction"%}}Environmentsヘルプページ{{%/link%}}を参照してください。

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

各環境の設定ファイル名は以下の通りです：
* Development: {{%badge%}}**app_configuration_development.properties**{{%/badge%}}
* Production: {{%badge%}}**app_configuration_production.properties**{{%/badge%}}

作業している環境に基づいて、適切なファイルをダウンロードしてAndroidアプリの構造に追加する必要があります。Production環境の設定ファイルを取得するには、まず{{%link href="/ja/deployment-and-billing/environments/initial-deployment"%}}プロジェクトをProductionにデプロイ{{%/link%}}してから、{{%italics%}}Developer Tools{{%/italics%}}設定セクションから{{%link href="/ja/getting-started/set-up-a-catalyst-project/developer-tools"%}}ファイルをダウンロード{{%/link%}}してください。

設定ファイルは、Androidアプリモジュールの{{%badge%}}**assets**{{%/badge%}}ディレクトリに追加する必要があります。通常、{{%badge%}}assets{{%/badge%}}フォルダは{{%badge%}}app/src/main{{%/badge%}}ディレクトリに作成されます。

Androidアプリモジュールの詳細については、{{%link href="https://developer.android.com/studio/projects"%}}Android公式ドキュメント{{%/link%}}を参照してください。

<br />

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

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

{{%note%}} {{%bold class="bold-primary"%}}Note{{%/bold%}}: これらの値の取得先については、表に記載されたリンクを参照してください。{{%/note%}}

<table class="content-table">
<thead>
<tr>
<th class="w20p">プロパティ</th>
<th class="w20p">データ型</th>
<th class="w60p">説明</th>
</tr>
</thead>
<tbody>
<tr> 
<td>{{%badge%}}**clientID**{{%/badge%}}</td>
<td>String</td>
<td>Catalystに登録されたアプリクライアントの一意の識別子です。設定ファイルで提供されます。</td>
</tr>

<tr> 
<td>{{%badge%}}**clientSecret**{{%/badge%}}</td>
<td>String</td>
<td>特定の{{%badge%}}clientID{{%/badge%}}に対して生成されたシークレット値で、APIリクエストとともに渡されます。設定ファイルで提供されます。</td>
</tr>

<tr> 
<td>{{%badge%}}**portalID**{{%/badge%}}</td>
<td>String</td>
<td>設定ファイルで提供される一意の識別子です</td>
</tr>
<tr> 
<td>{{%badge%}}**redirectUrl**{{%/badge%}}</td>
<td>String</td>
<td>前のステップでコンソールでパッケージを作成する際に指定した、アプリのコールバックURLです</td>
</tr>
<tr> 
<td>{{%badge%}}**projectID**{{%/badge%}}</td>
<td>Long</td>
<td>Catalystプロジェクトの{{%link href="/ja/getting-started/set-up-a-catalyst-project/general-settings/" %}}一意のID{{%/link%}}です</td>
</tr> 
<tr>
<td>{{%badge%}}**apiBaseURL**{{%/badge%}}</td>
<td>String</td>
<td>内部APIが呼び出されるCatalystサーバーのURLです。作業している環境に基づいて、適切なURL（{{%link href="/ja/deployment-and-billing/environments/development-environment/#function-url-and-web-app-url-in-the-development-environment"%}}Development URL{{%/link%}}または{{%link href="/ja/deployment-and-billing/environments/production-environment/#function-url-and-web-app-url-in-the-production-environment"%}}Production URL{{%/link%}}）を使用してください。</td>
</tr>
<tr>
<td>{{%badge%}}**oauthScopes**{{%/badge%}}</td>
<td>String</td>
<td>プロジェクトからCatalyst APIにアクセスするためにアプリが使用するスコープです。利用可能なOAuthスコープは{{%link href="/ja/api/oauth2/scopes/#Scopes" %}}こちら{{%/link%}}で確認できます。</td>
</tr>
<tr>
<td>{{%badge%}}**requestHeaders**{{%/badge%}}</td>
<td>String</td>
<td>HTTPリクエストでクライアントが送信するヘッダーです<br /> リクエストヘッダーの値は、コンマで区切られた個別のキーバリューペアで指定する必要があります：{{%badge%}}requestHeaders={{%/badge%}}{{%italics%}}key1:value1, key2:value2{{%/italics%}}</td>
</tr>
<tr>
<td>{{%badge%}}**serverTLD**{{%/badge%}}</td>
<td>String</td>
<td>データサーバーのトップレベルドメインです<br /> 許容値：{{%badge%}}**AU**{{%/badge%}}、{{%badge%}}**CN**{{%/badge%}}、{{%badge%}}**COM**{{%/badge%}}、{{%badge%}}**EU**{{%/badge%}}、{{%badge%}}**IN**{{%/badge%}}</td>
</tr>
<tr>
<td>{{%badge%}}**printStackTrace**{{%/badge%}}</td>
<td>Boolean</td>
<td>{{%badge%}}**printStackTrace**{{%/badge%}}の値が「{{%bold%}}true{{%/bold%}}」に設定されている場合、ログの詳細なトレースを取得できます。デフォルト値は「{{%bold%}}false{{%/bold%}}」です。</td>
</tr>
<tr>
<td>{{%badge%}}**minLogLevel**{{%/badge%}}</td>
<td>String</td>
<td>アプリのログ設定を行えます<br /> 許容値：{{%badge%}}**warnings**{{%/badge%}}、{{%badge%}}**errors**{{%/badge%}}、{{%badge%}}**information**{{%/badge%}}、{{%badge%}}**debug**{{%/badge%}}、{{%badge%}}**ALL**{{%/badge%}}</td>
</tr>
<tr>
<td>{{%badge%}}**httpRequestMode**{{%/badge%}}</td>
<td>String</td>
<td>HTTPリクエストが同期か非同期かを定義します<br /> 許容値：{{%badge%}}**SYNC**{{%/badge%}}、{{%badge%}}**ASYNC**{{%/badge%}}<br /> デフォルト値：{{%badge%}}ASYNC{{%/badge%}}</td>
</tr>
<tr>
<td>{{%badge%}}**connectTimeOut<br>InSec**{{%/badge%}}</td>
<td>Long</td>
<td>SDKから送信されるHTTPリクエストの接続タイムアウト値（秒単位）です<br /> つまり、この時間内にサーバーからクライアントリクエストへのレスポンスが受信されない場合、接続が終了します</td>
</tr>
<tr>
<td>{{%badge%}}**readTimeOutInSec**{{%/badge%}}</td>
<td>Long</td>
<td>SDKから送信されるHTTPリクエストの読み取りタイムアウト値（秒単位）です<br /> つまり、この時間内にサーバーからデータが受信されない場合、接続が終了します</td>
</tr>
<tr>
<td>{{%badge%}}**writeTimeOutInSec**{{%/badge%}}</td>
<td>Long</td>
<td>SDKから送信されるHTTPリクエストの書き込みタイムアウト値（秒単位）です<br /> つまり、この時間内にリクエストデータのサーバーへの書き込みまたは送信に失敗した場合、接続が終了します</td>
</tr>
<tr>
<td>{{%badge%}}**JWTClientID**{{%/badge%}}</td>
<td>String</td>
<td>クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントIDプロパティです</td>
</tr>
<tr>
<td>{{%badge%}}**JWTClientSecret**{{%/badge%}}</td>
<td>String</td>
<td>クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントシークレットプロパティです</td>
</tr>
</tbody>
</table>

{{%note%}}{{%bold%}}Note{{%/bold%}}:<br />

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

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

<br />

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

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

このリダイレクトが正しく処理されるようにするには、以下のURLスキーマをAndroidアプリの{{%badge%}}strings.xml{{%/badge%}}ファイルに含めてください：
{{%code class="language-bash line-numbers"%}}&lt;string name="url_scheme"&gt;{redirection_url}&lt;/string&gt;
{{%/code%}}

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

Catalystでアプリの{{%link href="/ja/sdk/android/v2/setup/#step-1-register-your-android-app-with-catalyst"%}}パッケージを作成{{%/link%}}する際に設定した**Redirection URL**を、このコードの{{%badge%}}redirection_url{{%/badge%}}の代わりに渡す必要があります。

<br />

### ステップ4：必要な権限を設定する

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

* {{%badge%}}**INTERNET**{{%/badge%}}: Catalyst APIを実行するため
* {{%badge%}}**ACCESS_NETWORK_STATE**{{%/badge%}}: ネットワーク障害を処理するため

これらの権限を有効にするには、以下に示すように{{%badge%}}**AndroidManifest.xml**{{%/badge%}}ファイルで宣言する必要があります：
{{%code class="language-bash line-numbers"%}}&lt;uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/&gt;
&lt;uses-permission android:name="android.permission.INTERNET"/&gt;
{{%/code%}}

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

<br />

Androidをプライマリ開発ターゲットとしたFlutterアプリの構築のセットアップが完了しました。これで、{{%link href="/ja/sdk/flutter/v2/implement-flutter-sdk/" %}}アプリへのCatalyst Flutter SDKの実装{{%/link%}}に進むことができます。

前提条件と最小サポート環境

Android Studioまたはサポートされている任意のIDEでFlutterプロジェクトを作成してください
Androidプロジェクトが以下の最小サポート環境を満たしていることを確認してください：
- OS- Android API Level 21 (Lollipop 4.4)
- Kotlin- 1.3.20
- Gradle- 3.4.0
IDEでアプリを実行するためのデバイスまたはエミュレーターをセットアップしてください

セットアップ

FlutterおよびAndroidのセットアップの前提条件を満たした後、以下の手順に従ってAndroidパッケージをアプリにセットアップおよび統合してください。

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

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

プロジェクトのCatalystコンソールから設定アイコンをクリックします。
設定メニューのProject Settings配下にあるDeveloper Toolsに移動し、Androidタイルをクリックします。または、下のAdd Packageボタンをクリックすることもできます。

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

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

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

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

ステップ2：AndroidプロジェクトにConfiguration Fileをインポートする

Catalystは、アプリケーションの開発およびビルド用に、DevelopmentサンドボックスとライブのProduction環境の2つの作業環境を提供しています。詳細については、Environmentsヘルプページを参照してください。

各環境の設定ファイル名は以下の通りです：

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ファイルのプロパティ

Note: これらの値の取得先については、表に記載されたリンクを参照してください。

プロパティ	データ型	説明
clientID	String	Catalystに登録されたアプリクライアントの一意の識別子です。設定ファイルで提供されます。
clientSecret	String	特定のclientIDに対して生成されたシークレット値で、APIリクエストとともに渡されます。設定ファイルで提供されます。
portalID	String	設定ファイルで提供される一意の識別子です
redirectUrl	String	前のステップでコンソールでパッケージを作成する際に指定した、アプリのコールバックURLです
projectID	Long	Catalystプロジェクトの一意のIDです
apiBaseURL	String	内部APIが呼び出されるCatalystサーバーのURLです。作業している環境に基づいて、適切なURL（Development URLまたはProduction URL）を使用してください。
oauthScopes	String	プロジェクトからCatalyst APIにアクセスするためにアプリが使用するスコープです。利用可能なOAuthスコープはこちらで確認できます。
requestHeaders	String	HTTPリクエストでクライアントが送信するヘッダーですリクエストヘッダーの値は、コンマで区切られた個別のキーバリューペアで指定する必要があります：requestHeaders=key1:value1, key2:value2
serverTLD	String	データサーバーのトップレベルドメインです許容値：AU、CN、COM、EU、IN
printStackTrace	Boolean	printStackTraceの値が「true」に設定されている場合、ログの詳細なトレースを取得できます。デフォルト値は「false」です。
minLogLevel	String	アプリのログ設定を行えます許容値：warnings、errors、information、debug、ALL
httpRequestMode	String	HTTPリクエストが同期か非同期かを定義します許容値：SYNC、ASYNC デフォルト値：ASYNC
connectTimeOut InSec	Long	SDKから送信されるHTTPリクエストの接続タイムアウト値（秒単位）ですつまり、この時間内にサーバーからクライアントリクエストへのレスポンスが受信されない場合、接続が終了します
readTimeOutInSec	Long	SDKから送信されるHTTPリクエストの読み取りタイムアウト値（秒単位）ですつまり、この時間内にサーバーからデータが受信されない場合、接続が終了します
writeTimeOutInSec	Long	SDKから送信されるHTTPリクエストの書き込みタイムアウト値（秒単位）ですつまり、この時間内にリクエストデータのサーバーへの書き込みまたは送信に失敗した場合、接続が終了します
JWTClientID	String	クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントIDプロパティです
JWTClientSecret	String	クライアントに渡されるサードパーティ認証用に生成されたカスタムサーバートークン（JSON Web Tokenトークン）のクライアントシークレットプロパティです

Note:

設定ファイルのclientID、clientSecret、projectID、またはportalIDの値を変更すると、SDKおよびAndroidアプリの機能に影響します。これらの設定を変更する場合は、Developer Toolsセクションから必要なプロジェクトの新しいパッケージを作成し、適切な環境の新しい設定ファイルをダウンロードして、アプリの構造のassetsディレクトリに追加してください。
ダウンロードした設定ファイルに入力されたプロパティの値は、ZCatalystApp.configsオブジェクトを使用して動的にアクセスできます。

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

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

copy

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

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

Catalystでアプリのパッケージを作成する際に設定したRedirection URLを、このコードのredirection_urlの代わりに渡す必要があります。

ステップ4：必要な権限を設定する

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

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

copy

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

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

Androidをプライマリ開発ターゲットとしたFlutterアプリの構築のセットアップが完了しました。これで、アプリへのCatalyst Flutter SDKの実装に進むことができます。

最終更新日 2026-02-23 18:09:41 +0530 IST

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit

Environments Developer Tools Android SDK