katanaYamlCode static method
Contents of katana.yaml.
katana.yamlの中身。
Implementation
static String katanaYamlCode(bool showAllConfig) => """
# Describe the application information.
# アプリケーション情報を記載します。
app:
# The application icon is automatically set based on the image file specified in [path].
# Image files should be created as 1024 x 1024 png files.
# You can create an AdaptiveIcon for Android by specifying [background] and [foreground] in [adaptive_icon].
# [path]に指定された画像ファイルを元にアプリのアイコンを自動設定します。
# 画像ファイルは1024×1024のpngファイルで作成してください。
# [adaptive_icon]で[background]と[foreground]を指定するとAndroid用のAdaptiveIconを作成できます。
icon:
enable: false
path: assets/icon.png
adaptive_icon:
foreground:
background:
# Describe the application information.
# For each language code, put the normal title in [title] and a short title for the app in [short_title]. Provide an overview of the app in [overview].
# By increasing the language code, information corresponding to that language can be described.
# By specifying [domain], you can change the web og tags to those appropriate for that domain.
# Specify a support email address in the [email] field.
# Specify the AppStore app ID in [apple_app_id].
# アプリケーションの情報を記載します。
# それぞれの言語コードに対して[title]に通常タイトル、[short_title]にアプリ用の短いタイトルを記載します。[overview]にアプリの概要を記載します。
# 言語コードを増やすことでその言語に対応した情報を記載することができます。
# [domain]を指定することでWebのogタグをそのドメインに応じたものに変更することができます。
# [email]にはサポート用のメールアドレスを指定します。
# [apple_app_id]にはAppStoreのアプリIDを指定します。
info:
enable: false
email:
domain:
apple_app_id: # e.g. idxxxxxx
locale:
en:
title:
short_title:
overview:
${showAllConfig ? """
# Retrieve data from a spreadsheet retrieved by a specific Google Form.
# Please include the URL of the spreadsheet in [url] and the email address you collected in [email].
# If [domain] is specified, og tags for the Web are generated for that domain.
# Takes precedence over [info].
# 特定のGoogleフォームで取得したスプレッドシートからデータを取得します。
# [url]にスプレッドシートのURL、[email]に収集したメールアドレスを記載してください。
# [domain]を指定するとそのドメインに応じたWeb用のogタグを生成します。
# [info]よりも優先されます。
spread_sheet:
enable: false
url:
email:
domain:
""" : ""}
# Create a `CertificateSigningRequest.certSigningRequest` for iOS.
# Please include your support email address in [email].
# iOS用の`CertificateSigningRequest.certSigningRequest`を作成します。
# [email]にサポート用のEmailアドレスを記載してください。
csr:
enable: false
email:
# Convert the cer file created by Certificate in AppleDeveloperProgram from `CertificateSigningRequest.certSigningRequest` to a p12 file.
# `CertificateSigningRequest.certSigningRequest`からAppleDeveloperProgramのCertificateにて作成されたcerファイルをp12ファイルに変換します。
p12:
enable: false
# Create a keystore for Android.
# Enter the alias of the keystore in [alias], the common name in [name], the organization name in [organization], the state or province in [state], and the country in [country].
# Android用のkeystoreを作成します。
# [alias]にkeystoreのエイリアス、[name]に共通名、[organization]に組織名、[state]に州や都道府県、[country]に国名を入力してください。
keystore:
enable: false
alias:
name:
organization:
state: Tokyo
country: Japan
# Configure the PrivacyManifest settings for IOS.
# Specify an array of [type] and [reason] in [manifests].
# [type] can be `user_defaults`, `file_timestamp`, `system_boot_time`, `disk_space`, or `active_keyboards`.
# [reason] specifies the following IDs.
# IOSのPrivacyManifestの設定を行います。
# [manifests]に[type]と[reason]の配列を指定します。
# [type]は`user_defaults`、`file_timestamp`、`system_boot_time`、`disk_space`、`active_keyboards`が指定できます。
# [reason]は下記のIDを指定します。
# [active_keyboards]
# - `3EC4.1`: Custom keyboard app on-device, per documentation
# - `54BD.1`: Customize UI on-device, per documentation
# [disk_space]
# - `85F4.1`: Display to user on-device, per documentation
# - `7D9E.1`: User-initiated bug report, per documentation
# - `E174.1`: Write or delete file on-device, per documentation
# [file_timestamp]
# - `0A2A.1`: 3rd-party SDK wrapper on-device, per documentation
# - `3B52.1`: Files provided to app by user, per documentation
# - `C617.1`: Inside app or group container, per documentation
# - `DDA9.1`: Display to user on-device, per documentation
# [system_boot_time]
# - `35F9.1`: Measure time on-device, per documentation
# [user_defaults]
# - `1C8F.1`: Access info from same App Group, per documentation
# - `AC6B.1`: Access managed app configuration, per documentation
# - `C56D.1`: 3rd-party SDK wrapper on-device, per documentation
# - `CA92.1`: Access info from same app, per documentation
privacy_manifests:
enable: false
manifests:
- type: user_defaults
reason: C56D.1
- type: file_timestamp
reason: 0A2A.1
# Describe the settings for using the AppTrackingTransparency library.
# Specify the permission message to use the library in IOS in [permission].
# Please include `en`, `ja`, etc. and write the message in that language there.
# AppTrackingTransparencyライブラリを利用するための設定を記述します。
# [permission]にIOSでライブラリを利用するための権限許可メッセージを指定します。
# `en`や`ja`などを記載しそこにその言語でのメッセージを記述してください。
app_tracking_transparency:
enable: false
permission:
en: If you [Allow], App will display ads optimized for you.
# Describe the settings for using the file picker.
# Specify the permission message to use the library in IOS in [permission].
# Please include `en`, `ja`, etc. and write the message in that language there.
# If you want to use the camera, set [camera]->[enable] to true and specify the permission message to use the camera in [permission].
# ファイルピッカーを利用するための設定を記述します。
# [permission]にIOSでライブラリを利用するための権限許可メッセージを指定します。
# `en`や`ja`などを記載しそこにその言語でのメッセージを記述してください。
# カメラを利用する場合は[camera]->[enable]をtrueにして、[permission]にカメラを利用するための権限許可メッセージを指定して下さい。
picker:
enable: false
permission:
en: Use the library for profile images.
camera:
enable: false
permission:
en: Use the camera for profile images.
${showAllConfig ? """
# Configure settings for mobile app deep linking.
# Describe the URI with URL scheme in [host].
# It is possible to create a universal link using https by enabling [server] and deploying the web to a server with the corresponding [host].
# [android_sha_256] specifies the SHA-256 hash value of the **signature certificate managed by Google Play**.
# モバイルアプリのディープリンク用の設定を行います。
# [host]にURLスキームを入れたURIを記述してください。
# [server]を有効にしてWebを該当の[host]を持つサーバーにデプロイするとhttpsを使ったユニバーサルリンクを作成することが可能です。
# [android_sha_256]は**GooglePlayでマネージされている**署名証明書のSHA-256ハッシュ値を指定します。
# ```
# host: https://mathru.net
# ```
deeplink:
enable: false
host:
server:
enable: false
ios_team_id:
android_sha_256:
# Describes settings for implementing animation.
# アニメーションを実装するための設定を記述します。
animate:
enable: false
# Describe the settings for using the introductory part of the application.
# アプリの導入部分を利用するための設定を記述します。
introduction:
enable: false
# Describe the settings for using the camera.
# カメラを利用するための設定を記述します。
camera:
enable: false
# Specifies whether audio is enabled on the camera.
# カメラで音声を有効にするかを指定します。
audio:
enable: true
# Specify permission permission messages to use the camera and microphone in IOS.
# IOSでカメラやマイクを利用するための権限許可メッセージを指定します。
permission:
camera:
en: Use the camera for video chats.
microphone:
en: Use the microphone for video chatting.
# Describe the settings for using the calendar.
# カレンダーを利用するための設定を記述します。
calendar:
enable: false
# Describe the settings for using OpenAI's GPT, etc.
# OpenAIのGPT等を利用するための設定を記述します。
openai:
enable: false
# Describe the settings for using speech synthesis.
# 音声合成による発話を利用するための設定を記述します。
text_to_speech:
enable: false
# Describe the settings for using voice recognition.
# Specify the permission message to use the library in IOS in [permission].
# Please include `en`, `ja`, etc. and write the message in that language there.
# 音声認識を利用するための設定を記述します。
# [permission]にIOSでライブラリを利用するための権限許可メッセージを指定します。
# `en`や`ja`などを記載しそこにその言語でのメッセージを記述してください。
speech_to_text:
enable: false
permission:
en: Used to perform voice recognition.
# Implement local PUSH.
# ローカルPUSHを実装します。
local_notification:
enable: false
""" : ""}
# This section contains information related to Firebase.
# Firebase関連の情報を記載します。
firebase:
# Set the Firebase project ID.
# FirebaseのプロジェクトIDを設定します。
project_id:
# Enable Firebase Firestore.
# Set [generate_rules_and_indexes] to `true` to automatically generate Firestore security rules and indexes.
# If [primary_remote_index] is set to `true`, indexes on the console are prioritized and automatic index import is enabled.
# Firebase Firestoreを有効にします。
# [generate_rules_and_indexes]を`true`にするとFirestoreのセキュリティルールとインデックスを自動生成します。
# [primary_remote_index]を`true`にするとコンソール上のインデックスが優先されるため、インデックスの自動インポートが有効になります。
firestore:
enable: false
generate_rules_and_indexes: false
primary_remote_index: false
# Enable Firebase Data Connect.
# Firebase Data Connectを有効にします。
dataconnect:
enable: false
# Enable Firebase Authentication.
# Firebase Authenticationを有効にします。
authentication:
enable: false
${showAllConfig ? """
# If you want to add user deletion functionality, set [enable] to `true`.
# ユーザー削除機能を追加する場合は[enable]を`true`にしてください。
delete_user:
enable: false
# If you want to use SNS providers, set [enable] to `true` for each SNS.
# SNSプロバイダーを利用したい場合はそれぞれのSNSの[enable]を`true`にしてください。
providers:
# SignIn with apple.
# When creating an application ID from the URL below, look for "Sign In with Apple" in the Capabilities section and check the box.
# https://developer.apple.com/account/resources/identifiers/list
# Also, from the Firebase console (https://console.firebase.google.com/), select [Authentication]->[Sing-in method] and enable `Apple`.
# SignIn with appleを利用します。
# 下記URLからアプリケーションIDを作成する際にCapabilitiesの項目の中から「Sign In with Apple」を探しチェックを入れてください。
# https://developer.apple.com/account/resources/identifiers/list
# またFirebaseのコンソール(https://console.firebase.google.com/)から[Authentication]->[Sing-in method]を選択し`Apple`を有効にしてください。
apple:
enable: false
# Sign in with your Google account.
# Get the settings for Google Login automatically from Firebase settings.
# Also, from the Firebase console (https://console.firebase.google.com/), select [Authentication]->[Sing-in method] and enable `Google`.
# To log in via the web, follow the steps below to enable the API.
# 1. Select the item "OAuth 2.0 Client ID" whose "Type" is "Web Application".
# https://console.cloud.google.com/apis/credentials
# 2. List the domain where the website is open in the "Authorized JavaScript Generator" field.
# e.g.) https://example.com
# Also, at the time of release, please follow the steps below to obtain the SHA-256 hash value of the app's signing certificate and add it to the Firebase configuration.
# If not added, Google Login will be disabled only for the build of the distribution.
# 1. open GooglePlayConsole and select your app.
# 2. Open [Settings]->[App Signature].
# 3. Copy the SHA-256 hash value listed.
# 4. In Firebase, go to [Project Settings]->[General]->[My Apps]->[Android Apps] and add the value you copied to [SHA Certificate Fingerprints].
# Googleアカウントによるログインを行います。
# Firebaseの設定から自動でGoogleログイン用の設定を取得します。
# またFirebaseのコンソール(https://console.firebase.google.com/)から[Authentication]->[Sing-in method]を選択し`Google`を有効にしてください。
# Webでのログインは下記の手順でAPIを有効にします。
# 1. 「OAuth 2.0 クライアント ID」の[種類]が[ウェブアプリケーション]の項目を選択します。
# https://console.cloud.google.com/apis/credentials
# 2. 「承認済みの JavaScript 生成元」にWebサイトを開いているドメインを記載します。
# 例)https://example.com
# またリリース時には下記の手順でアプリの署名証明書のSHA-256ハッシュ値を取得し、Firebaseの設定に追加してください。
# 追加しない場合、配信のビルドのみGoogleログインが出来ない状態になります。
# 1. GooglePlayConsoleを開き、アプリを選択します。
# 2. [設定]->[アプリの署名]を開く。
# 3. 記載されているSHA-256ハッシュ値をコピーします。
# 4. Firebaseの[プロジェクトの設定]->[全般]->[マイアプリ]->Androidのアプリから[SHA証明書フィンガープリント]にコピーした値を追加します。
google:
enable: false
# Log in with your Facebook account.
# Get the following settings for Facebook login.
# https://www.notion.so/mathru/Meta-Facebook-7acf4e522e7d42998a9dcc613a0b7760
# Please enter [AppId] and [AppSecret] in each field.
# Also, from the Firebase console (https://console.firebase.google.com/), select [Authentication]->[Sing-in method] and enable `Facebook`.
# Facebookアカウントによるログインを行います。
# 下記の設定でFacebookログイン用の設定を取得します。
# https://www.notion.so/mathru/Meta-Facebook-7acf4e522e7d42998a9dcc613a0b7760
# [AppId]と[AppSecret]を各項目に記載してください。
# またFirebaseのコンソール(https://console.firebase.google.com/)から[Authentication]->[Sing-in method]を選択し`Facebook`を有効にしてください。
facebook:
enable: false
app_id:
app_secret:
client_token:
""" : ""}
# Enable Cloud Storage for Firebase.
# If you want to use CORS to retrieve images, etc., set [cors] to `true`.
# Cloud Storage for Firebaseを有効にします。
# CORSで画像等を取得する場合は[cors]を`true`にしてください。
storage:
enable: false
cors: false
# Enable Cloud Functions for Firebase.
# Cloud Functions for Firebaseを有効にします。
functions:
enable: false
# Specify the Region for FirebaseFunctions.
# Please refer to the following link for the Region of FirebaseFunctions.
# FirebaseFunctionsのRegionを指定します。
# FirebaseFunctionsのRegionは以下のリンクを参考にしてください。
# https://firebase.google.com/docs/functions/locations?hl=ja
region: asia-northeast1
# Enable Firebase Analytics and Firebase Crashlytics.
# If you are unable to activate Analytics, please check if the "Project Settings" -> "Integration" -> "GoogleAnalytics" application is successfully linked.
# Firebase AnalyticsとFirebase Crashlyticsを有効にします。
# Analyticsの有効化が出来ない場合は、「プロジェクトの設定」→「統合」→「GoogleAnalytics」のアプリが正常に連携されているかを確認してください。
logger:
enable: false
# Configure Firebase Hosting settings.
# Set [use_flutter] to `true` so that all routes point to index.html, and set it to `true` when using Flutter Web.
# Even in the above case, /**/terms.html and /**/privacy.html will not be directed to the root.
# Set [github_actions] to `true` to deploy to Firebase Hosting with Github Actions.
# Firebase Hostingの設定を行います。
# [use_flutter]を`true`にするとすべてのルートがindex.htmlを向くようになります。Flutter Webを利用する際に`true`にしてください。
# 上記の場合でも/**/terms.html、/**/privacy.htmlはルートに向かないようになります。
# [github_actions]を`true`にするとGithub ActionsでFirebase Hostingにデプロイするようになります。
hosting:
enable: false
github_actions: false
use_flutter: true
# Configure Firebase DynamicLinks.
# Describe the URI with URL scheme in [host].
# Firebase DynamicLinksの設定を行います。
# [host]にURLスキームを入れたURIを記述してください。
# ```
# host: https://mathru.net
# ```
dynamic_links:
enable: false
host:
# The contents of the target [path] document are indexed by Algolia and made searchable.
# Please enter Algolia's Application ID in [app_id] and Algolia's API Key in [api_key].
# Each can be confirmed and issued from the [API Key] screen of the [Settings] screen on the lower left of the dashboard.
# [path] must be a path for the collection.
# 対象の[path]のドキュメントの内容をAlgoliaにてインデックスし、検索可能にします。
# [app_id]にAlgoliaのApplication ID、[api_key]にAlgoliaのAPI Keyを記載してください。
# それぞれダッシュボードの左下の[Settings]画面の[API Key]の画面から確認・発行が可能です。
# [path]は必ずコレクション用のパスである必要があります。
algolia:
enable: false
path:
app_id:
api_key:
${showAllConfig ? """
# Deploy Terms of Use and Privacy Policy data to Firebase Hosting.
# Under each language code, [terms_of_use] and [privacy_policy] and [how_to_delete] should include the URL for the terms of use, privacy policy, and deletion method.
# The [index] should contain the URL of the page that summarizes them.
# Adding a language code allows you to include the Terms of Use and Privacy Policy for that language, as well as the URL for removal instructions.
# \${ApplicationName} and \${SupportEmail} will be replaced with the app name and support email address, respectively.
# Firebase Hostingに利用規約とプライバシーポリシーのデータをデプロイします。
# 各言語コードの下に[terms_of_use]と[privacy_policy]、[how_to_delete]には利用規約とプライバシーポリシー、削除方法のURLを記載してください。
# [index]にはそれらをまとめるページのURLを記載してください。
# 言語コードを追加するとその言語の利用規約とプライバシーポリシー、削除方法のURLを記載することができます。
# \${ApplicationName}と\${SupportEmail}がそれぞれアプリ名とサポート用のEmailアドレスに置き換わります。
terms_and_privacy:
enable: false
en:
index:
terms_of_use:
privacy_policy:
how_to_delete:
ja:
index:
terms_of_use:
privacy_policy:
how_to_delete:
""" : ""}
# Enable Firebase Messaging.
# Specify ChannelNotificationId for Android in [channel_id].
# Specify an image path in [android_notification_icon] to set a notification icon for Android for whiteout.
# Firebase Messagingを有効にします。
# [channel_id]にAndroid用のChannelNotificationIdを指定してください。
# [android_notification_icon]に画像パスを指定するとAndroid用の白抜き用の通知アイコンを設定できます。
messaging:
enable: false
channel_id:
android_notification_icon:
${showAllConfig ? """
# Describe the settings for creating a mechanism to copy Firestore documents at a specified time or to send notifications at a specified time.
# If you put a schedule such as `every 10 minutes` in [time], it can be executed at the specified time.
# 指定した時間にFirestoreのドキュメントをコピーしたり、指定した時間に通知を送信したりする仕組みを作成するための設定を記述します。
# [time]に`every 10 minutes`のようなスケジュールを記述すると指定した時間に実行することができます。
scheduler:
enable: false
time:
""" : ""}
${showAllConfig ? """
# This section contains information related to Git.
# Git関連の情報を記載します。
git:
# Add secure files to .gitignore.
# If `false`, password files, etc. will be uploaded to Git.
# Please limit your use to private repositories only.
# セキュアなファイルを.gitignoreに追加します。
# `false`にした場合、パスワードファイルなどがGitにアップロードされることになります。
# プライベートレポジトリのみでの利用に限定してください。
ignore_secure_file: true
# Ensure that the dart code is modified and verified before committing.
# lefthand installation is required.
# コミット前にdartコードの修正や確認を行うようにします。
# lefthandのインストールが必要です。
pre_commit:
enable: false
""" : ""}
# Github-related information will be described.
# Github関連の情報を記載します。
github:
# Enable Github Actions to perform CI/CD builds on each platform.
# Enter a numerical value in [increment_number] to set the initial value for the version number increment.
# Enter the platform you wish to specify in [platform], separated by spaces.
# Available platforms are `android`, `ios`, `web`, `windows`, `macos`, and `linux`.
# Github Actionsを有効にして各プラットフォームでCI/CDビルドを行うようにします。
# [increment_number]に数値を記入するとバージョン番号のインクリメントの初期値を設定できます。
# [platform]で指定したいプラットフォームをスペース区切り入力します。
# 使用できるプラットフォームは`android`、`ios`、`web`、`windows`、`macos`、`linux`です。
#
# [Android]
# Json for the service account is required under the `android` folder, please refer to https://mathru.notion.site/Google-Play-Developer-df655aff2dfb49988b82feb7aae3c61b to set it up Please refer to the `android` folder to set it up.
#
# [IOS]
# AuthKey_xxxxx.p8 file and development.p12 generated from development.cer are required under the `ios` folder. https://mathru.notion.site/AppStoreConnect-ID-f516ff1a Please refer to 767146f69acd6780fbcf20fe to set it up.
#
# [Android]
# サービスアカウント用のJsonが`android`フォルダ以下に必要です。https://mathru.notion.site/Google-Play-Developer-df655aff2dfb49988b82feb7aae3c61b を参考に設定してください。
#
# [IOS]
# AuthKey_xxxx.p8ファイルとdevelopment.cerから生成したdevelopment.p12が`ios`フォルダ以下に必要です。https://mathru.notion.site/AppStoreConnect-ID-f516ff1a767146f69acd6780fbcf20feを参考に設定してください。
action:
enable: false
increment_number: 1
platform: android ios web
android:
# Change to completed after the app is released.
# アプリをリリースした後は completed に変更してください。
status: draft
changes_not_sent_for_review: false
web:
# Specify a renderer for the Web. (html | canvaskit)
# Web用のレンダラーを指定します。(html | canvaskit)
renderer: canvaskit
# Please include the path to your current repository on Github in the format `user/repository name`.
# Githubの現在のリポジトリのパスを`ユーザー/レポジトリ名`のフォーマットで記載してください。
repository:
ios:
# Copy the Issuer ID listed on the page at https://appstoreconnect.apple.com/access/api.
# https://appstoreconnect.apple.com/access/api のページに記載されているIssuer IDをコピーしてください。
issuer_id:
# Please copy and include your team ID from https://developer.apple.com/account.
# https://developer.apple.com/account のチームIDをコピーして記載してください。
team_id:
# Describe the settings for automatic review when a Github pull request is created.
# Enter the OpenAI API key in [openai_api_key].
# Githubのプルリクエストが作成された際に自動でレビューを行うための設定を記述します。
# OpenAIのAPIキーを[openai_api_key]に記述してください。
review:
enable: false
openai_api_key:
${showAllConfig ? """
# Store-related information.
# ストア関連の情報を記載します。
store:
# Create a simple screenshot to be posted in the store. It can be executed with the following command.
# ストアに掲載する簡易的なスクリーンショットの作成を行います。下記コマンドで実行可能です。
# `katana store screenshot`
#
# Generate images for screenshots in [export_dir] based on the list of images in [source_dir].
# You can specify the orientation (`portrait` or `landscape`) with [orientation] and the background color with [color].
# [source_dir]にある画像一覧を元に[export_dir]にスクリーンショット用の画像を生成します。
# [orientation]で(`portrait` or `landscape`)向きを指定でき、[color]を指定すると背景色を指定できます。
screenshot:
source_dir: documents/screenshot
export_dir: documents/store
feature_image: documents/feature.png
icon: documents/icon.png
orientation: portrait
color: '000000'
purchase_position: center
title: 'Title'
icon_position:
x: 12
y: 12
# Describe the settings for using location information.
#
# Set [enable_background] to true if you want to acquire location information even when the application enters the background.
# If you wish to use GoogleMap, set [google_map]->[enable] to true. Also, obtain a GoogleMap API key from the following link in advance and enter it in [google_map]->[api_key].
# https://console.cloud.google.com/google/maps-apis/credentials
#
# If you want to use Geocoding to obtain location information from addresses, set [geocoding]->[enable] to true. Also, please obtain an API key for Geocoding from the link below and enter it in the [geocoding]->[api_key] field.
# https://console.cloud.google.com/google/maps-apis/credentials
#
# Specify the permission message to use the library in IOS in [permission].
# Please include `en`, `ja`, etc. and write the message in that language there.
#
# 位置情報を利用するための設定を記述します。
#
# アプリがバックグラウンドに入った場合でも位置情報を取得する場合は[enable_background]をtrueにしてください。
# GoogleMapを利用する場合は[google_map]->[enable]をtrueにしてください。また事前に下記のリンクからGoogleMapのAPIキーを取得しておき[google_map]->[api_key]に記載してください。
# https://console.cloud.google.com/google/maps-apis/credentials
#
# Geocodingで住所から位置情報を取得する場合は[geocoding]->[enable]をtrueにしてください。また事前に下記のリンクからGeocoding専用のAPIキーを取得しておき[geocoding]->[api_key]に記載してください。
# https://console.cloud.google.com/google/maps-apis/credentials
#
# [permission]にIOSでライブラリを利用するための権限許可メッセージを指定します。
# `en`や`ja`などを記載しそこにその言語でのメッセージを記述してください。
location:
enable: false
enable_background: false
google_map:
enable: false
api_key:
android:
ios:
web:
geocoding:
enable: false
api_key:
permission:
en: Location information is used to display the map.
# Describe the settings for using the app economic system.
# アプリ経済システムを利用するための設定を記述します。
ecosystem:
enable: false
# Specify the ecosystem type.
# エコシステムの種類を指定します。
#
# [point]:
# Create an economic system centered on points.
# Points can be purchased by paying bills, increased through reward ads, login bonuses, etc.
# Points can be used to access features within the application.
# [purchase] and [ads] must be set.
# ポイントを中心とした経済システムを構築します。
# ポイントを課金で購入したり、リワード広告で増やしたり、ログインボーナス等で増やします。
# ポイントを利用することでアプリ内の機能を利用することが可能です。
# [purchase]と[ads]の設定が必要です。
type: point
# Configure the settings for advertising.
# Set the respective Ad App Id in [android_app_id] and [ios_app_id].
# If you want to use it on the web, please obtain app_ads.txt and place it under the web folder.
# https://admanager.google.com/home/
# Specify the permission message to use the library in IOS in [permission].
# Please include `en`, `ja`, etc. and write the message in that language there.
# 広告を出す場合の設定を行います。
# [android_app_id]と[ios_app_id]にそれぞれのAd App Idを設定してください。
# Webで利用する場合はapp_ads.txtを取得し、webフォルダ以下に配置してください。
# https://admanager.google.com/home/
# [permission]にIOSでライブラリを利用するための権限許可メッセージを指定します。
# `en`や`ja`などを記載しそこにその言語でのメッセージを記述してください。
ads:
enable: false
android_app_id:
ios_app_id:
permission:
en: If you [Allow], App will display ads optimized for you.
# Configure settings for store billing.
# ストア課金を行う場合の設定を行います。
purchase:
# Setting this to `true` will install the billing package for testing.
# ここを`true`にするとテスト用の課金パッケージがインストールされます。
enable: false
# Configure settings for Google Play billing.
# Follow the steps below to configure the settings.
# 1. Create a service account with permissions to GooglePlayConsole based on the URL below.
# https://mathru.notion.site/Android-1d4a60948a1446d7a82c010d96417a3d?pvs=4
# ※ You need to create an OAuth consent screen. Please create it from the following URL.
# https://console.cloud.google.com/apis/credentials/consent
# 2. Set `enable` to `true`.
# 3. Set the topic ID for the notification to `pubsub_topic`.
# 4. Run `katana apply` to deploy the app and server.
# GooglePlayの課金を行う場合の設定を行います。
# 下記の手順で設定を行います。
# 1. 下記URLを元にGooglePlayConsoleに権限があるサービスアカウントを作成します。
# https://mathru.notion.site/Android-1d4a60948a1446d7a82c010d96417a3d?pvs=4
# ※OAuthの同意画面を作成する必要があります。下記のURLから作成してください。
# https://console.cloud.google.com/apis/credentials/consent
# 2. `enable`を`true`にします。
# 3. 通知用のトピックIDを`pubsub_topic`に設定します。
# 4. `katana apply`を実行しアプリとサーバーのデプロイを行います。
google_play:
enable: false
pubsub_topic: purchasing
# Configure settings for AppStore billing.
# Follow the steps below to configure the settings.
# 1. Register your tax information and bank account to activate [Subscription]->[Paid Apps] in the AppStore.
# 2. Get it from [AppStore]->[App Info]->[Shared Secret for App] and put it in `shared_secret`.
# AppStoreの課金を行う場合の設定を行います。
# 下記の手順で設定を行います。
# 1. AppStoreの[契約]->[有料App]をアクティブにするように税務情報や銀行口座を登録します。
# 2. AppStoreの[アプリ]->[App情報]->[App用共有シークレット]から取得して`shared_secret`に記載します。
app_store:
enable: false
shared_secret:
# Configure billing settings for Stripe.
# Stripeの課金設定を行います。
stripe:
# Set to `true` if you use Stripe.
# Stripeを利用する場合は`true`にしてください。
enable: false
# Set to `true` if you use Stripe Connect.
# Stripeコネクトを利用する場合は`true`にしてください。
enable_connect: false
# Secret key for Stripe's API.
# You can obtain keys for the test and production environments at the following URLs
# StripeのAPI用シークレットキー。
# 下記のURLからテスト環境用と本番環境用のキーを取得できます。
# Production environment
# https://dashboard.stripe.com/apikeys
# Development enveironment
# https://dashboard.stripe.com/test/apikeys
secret_key:
# URL scheme for returning from Stripe's WebView.
# It must be set to the same settings as the application side.
# StripeのWebViewから戻る際のURLスキーム。
# アプリ側と同じ設定にする必要があります。
url_scheme:
# Specify the email provider for use with Stripe's 3D Secure authentication.
# Specify `sendgrid` if you use SendGrid or `gmail` if you use Gmail.
# Also, please set up various e-mail settings.
# Stripeの3Dセキュア認証で利用するためのメールプロバイダーを指定します。
# SendGridを利用する場合は`sendgrid`、Gmailを利用する場合は`gmail`を指定してください。
# また、各種メールの設定を行ってください。
email_provider: sendgrid
# Set up a redirect page for 3D Secure.
# Under each language code, [success] and [failure] should include the URL for success and failure.
# Adding a language code allows you to include the URL for that language.
# 3Dセキュア用のリダイレクトページを設定します。
# 各言語コードの下に[success]と[failure]には成功時、失敗時のURLを記載してください。
# 言語コードを追加するとその言語のURLを記載することができます。
three_d_secure_redirect_page:
en:
success:
failure:
ja:
success:
failure:
# Configure Agora.io streaming settings.
# Agora.ioのストリーミング設定を行います。
agora:
# Set to `true` if you use Agora.io.
# Agora.ioを利用する場合は`true`にしてください。
enable: false
# AppID for Agora.
# Log in to the following URL and create a project.
# After the project is created, the AppID can be copied.
# Agora用のAppID。
# 下記URLにログインし、プロジェクトを作成します。
# プロジェクト作成後、AppIDをコピーすることができます。
# https://console.agora.io/projects
app_id:
# AppCertificate for Agora.
# You can obtain the certificate after entering the project you created and activating it in Security -> App certificate.
# Agora用のAppCertificate。
# 作成したプロジェクトに入り、Security -> App certificateにて有効化した後取得できます。
# https://console.agora.io/projects
app_certificate:
# Set to `true` to enable Agora cloud recording.
# Agoraのクラウドレコーディングを有効にする場合は`true`にしてください。
enable_cloud_recording: false
# Set to `true` to enable Agora full screen sharing.
# Agoraのフルスクリーン共有を有効にする場合は`true`にしてください。
enable_fullscreen_sharing: false
# Specify permission permission messages to use the camera and microphone in IOS.
# IOSでカメラやマイクを利用するための権限許可メッセージを指定します。
permission:
camera:
en: Use the camera for video chats.
microphone:
en: Use the microphone for video chatting.
# Configure Gmail sending settings.
# Gmailの送信設定を行います。
gmail:
# Set to `true` if you want to use Gmail to send emails.
# Gmailによるメール送信を利用する場合は`true`にしてください。
enable: false
# Gmail user ID. Follow the steps below to obtain a Gmail user ID.
# 1. Press your icon in the upper right corner of the Google top screen and open "Manage Google Account".
# 2. open "Security" on the left side of the screen and open "App Password
# GmailのユーザーID。下記の手順で取得します。
# 1. Googleのトップ画面の画面右上の自分のアイコンを押下し、「Google アカウントを管理」を開く
# 2. 画面左の「セキュリティ」を開き、「アプリ パスワード」を開く
user_id:
# Gmail user password. Enter the password obtained in the above procedure.
# Gmailのユーザーパスワード。上記の手順で取得したパスワードを入力します。
user_password:
# Configure Sendgrid sending settings.
# Sendgridの送信設定を行います。
sendgrid:
# Set to `true` if you want to use mail sending by Sendgrid.
# Sendgridによるメール送信を利用する場合は`true`にしてください。
enable: false
# API key for SendGrid. It can be issued from the following URL.
# SendGridのAPIキー。下記URLから発行可能です。
# https://app.sendgrid.com/settings/api_keys
api_key:
""" : ""}
""";