Rtoaster SDK の初期化 #
アプリ起動時に Rtoaster.setup メソッドを用いて、RtoasterSDK の初期化を行います。この初期化では、下記の項目を指定します。
- トラッキングID
- 認証ユーザーID *1
- 認証ユーザーIDのパスワード
- 契約ドメイン名
- ユーザー同意状態 *2
*1: 認証ユーザーID, 認証パスワードは認証情報を発行した際にお知らせするIDとパスワードとなります。
*2: ユーザー同意状態の初期値に関しては、オプトアウト・オプトインの項目も併せてご確認ください。
なお、 isSetup
メソッドを呼び出すことで、SDKが初期化済みかどうかを判定できます。
初期化パラメータ #
SDK の初期化時のパラメータは、 RtoasterSetupParameter
クラスで指定します。
引数は以下の通り設定してください。認証ユーザーID、パスワードについては弊社に問合せください。
引数 | 説明 | 必須 |
---|---|---|
trackingId | トラッキングID | ○ |
userName | 認証ユーザーID *1 | |
password | 認証パスワード | ○ |
siteHostName | 契約ドメイン名 *2 | |
defaultConnection AuthorizationStatus |
ユーザー同意状態の初期値 | ○ |
isDryRunEnabled | ドライランを行うかどうか | false |
*1: 認証ユーザーIDがトラッキングIDと同じ場合は省略可能
*2: 契約ドメイン名を省略した場合は app://rtoaster.jp
*3: Rtoasterサービス解約時にはこの値を true
に設定してください。不要な通信を抑制するようになります。
引数 | 説明 | 必須 |
---|---|---|
application(Androidのみ) | Applicationオブジェクト | ○ |
trackingId | トラッキングID | ○ |
userName | 認証ユーザーID *1 | |
password | 認証パスワード | ○ |
siteHostName | 契約ドメイン名 *2 | |
defaultConnection AuthorizationStatus |
ユーザー同意状態の初期値 | ○ |
isDryRunEnabled | ドライランを行うかどうか *3 | false |
*1: 認証ユーザーIDがトラッキングIDと同じ場合は省略可能
*2: 契約ドメイン名を省略した場合は app://rtoaster.jp
*3: Rtoasterサービス解約時にはこの値を true
に設定してください。不要な通信を抑制するようになります。
ユーザー同意状態 #
アプリインストール直後のユーザー同意状態を指定するものです。
「オプトアウト/オプトイン」の実行後は、この値は無視されます。詳細は、オプトアウト/オプトインの項目をご覧ください。
ユーザー同意状態の値 | 意味 |
---|---|
Authorized | 同意状態 (SDKの機能を有効化) |
Denied | 非同意状態 (SDKの機能を無効化) |
契約ドメインの設定 #
初期化パラメータの siteHostName
には原則として契約ドメインを設定します。
値にはURL形式または任意の文字列の形式で指定することが可能です。設定を省略した場合「app://rtoaster.jp」が設定されます。
また、URL形式ではない文字列を設定した場合、冒頭に「app://」が補完されます。
ただし、個々のトラッキングの実行時にlocation指定値でURL形式の文字列を指定した場合、そのホスト部分がsiteHostNameの指定値よりも優先的にドメインとして送信されます。
siteHostNameの指定値とトラッキング実行時のlocationの指定値によってドメイン、ページとして何が送信されるかという例を下記表に記載します。
この際、URLの形式はRFC3986に準拠したものを設定してください。
siteHostNameの 指定値 |
track/recommend時の locationの指定値 |
ドメインとして 送信される値 |
ページとして送信される値 |
---|---|---|---|
設定なし | location | app://rtoaster.jp | /location |
設定なし | http://hostname.co.jp/location | http://hostname.co.jp | /location |
http://hostname.co.jp | location | http://hostname.co.jp | /location |
hostname.co.jp | location | http://hostname.co.jp | /location |
hostame.co.jp | http://hostname.co.jp/location | http://hostname.co.jp | /location |
コンポーネントライブラリの初期化 #
レコメンド表示(ポップアップ・アンケート表示)のライブラリを利用する場合には、コンポーネントライブラリの初期化を行います。
サンプルコード #
try Rtoaster.setup(RtoasterSetupParameter.Builder()
.trackingId("RTA-xxxx-xxxxxxxxxxxx")
.password("abcdefghijkl")
.defaultConnectionAuthorizationStatus(.authorized)
.hostName("https://www.brainpad.co.jp")
.build()
)
// RtoasterViewPlugin.xcframework を利用する場合
try RtoasterView.setup(RtoasterViewSetupParameter.Builder().build())
Rtoaster.setup(RtoasterSetupParameter {
application(this@XxxApplication)
trackingId("RTA-xxxx-xxxxxxxxxxxx")
password("abcdefghijkl")
defaultConnectionAuthorizationStatus(Rtoaster.ConnectionAuthorizationStatus.Authorized)
hostName("https://www.brainpad.co.jp")
})
// rtoaster-view-5.x.x.aar を利用する場合
RtoasterView.setup(RtoasterViewSetupParameter.Builder().build())