APIリファレンス 最終更新日 Fri, Jan 6, 2017
Edit on GitHubVersion 2.0.9
Growthbeat API
Growthbeatインスタンスの取得
Growthbeatインスタンスを取得します。
public static Growthbeat GetInstance ();
ログの停止
Growthbeat SDKからのログ出力を全て停止します。 デフォルトでは、ログ出力がおこなわれます。
public void SetLoggerSilent (bool silent);
パラメータ
| 項目名 | 詳細 |
|---|---|
| silent | ログ出力を行うか。YES: ログ出力しない NO:ログ出力をする |
IntentHandler API
ハンドラ
public static IntentHander GetInstance ();
処理をしないハンドラ
public void AddNoopIntentHandler ();
ブラウザを開くハンドラ
public void AddUrlIntentHandler ();
カスタムハンドラ
public void AddCustomIntentHandler (string gameObjectName, string methodName);
パラメータ
| 項目名 | 詳細 |
|---|---|
| gameObjectName | コールバックをするメソッドが存在するゲームオブジェクト |
| methodName | コールバックをするメソッド |
例.)
public class GrowthbeatComponent : MonoBehaviour
{
void Awake ()
{
IntentHandler.GetInstance ().AddCustomIntentHandler ("GrowthbeatComponent", "HandleCustomIntent");
}
void HandleCustomIntent(string extra) {
Debug.Log("Enter HandleCustomIntent");
Debug.Log(extra);
}
}
extraはJSON型の文字列が戻ってきます。
Growth Push API
Growth Pushインスタンスの取得
Growth Pushインスタンスを取得します。
public static GrowthPush GetInstance ();
初期化
GrowthbeatおよびGrowth Pushの初期化を行います。初期化では以下の処理が行われます。
- デバイス登録、認証
- Growth Pushの初期化
- 基本情報の送信
public void Initialize (string applicationId, string credentialId, Environment environment);
広告情報を保持しない場合
public void Initialize (string applicationId, string credentialId, Environment environment, bool adInfoEnable);
パラメータ
| 項目名 | 詳細 |
|---|---|
| applicationId | アプリケーションID |
| credentialId | クレデンシャルキー |
| environment | 開発用: Environment.development 本番用: Environment.production |
| adInfoEnabled | 広告情報の送信設定。true: 送信する false:送信しない |
デバイストークンの取得・送信
デバイストークンの取得
public void RequestDeviceToken (string senderId);
| 項目名 | 詳細 |
|---|---|
| senderId | Android の SenderId * iOSのみの場合は、引数なし |
デバイストークンの送信 (iOSのみ)
public void SetDeviceToken (string deviceToken);
デバイストークン取得 (Androidのみ)
public string GetDeviceToken ();
イベントの送信
イベントの送信
public void TrackEvent(string name);
パラメータ
| 項目名 | 詳細 |
|---|---|
| name | イベント名 |
イベントと任意の値の送信
public void TrackEvent (string name, string value);
パラメータ
| 項目名 | 詳細 |
|---|---|
| name | イベント名 |
| value | イベントに持たせる値 |
イベントと任意の値の送信
メッセージ表示のコールバックを、ゲームオブジェクトの指定メソッドへ戻します。 コールバックには、uuid の文字列が返ります。
public void TrackEvent (string name, string value, string gameObjectName, string methodName);
パラメータ
| 項目名 | 詳細 |
|---|---|
| name | イベント名 |
| value | イベントに持たせる値 |
| gameObjectName | コールバックするゲームオブジェクト |
| methodName | コールバックするメソッド名 |
ポップアップメッセージ表示
public void RenderMessage (string uuid);
| 項目名 | 詳細 |
|---|---|
| uuid | TrackEvent時のコールバックされた文字列 |
タグの送信
タグの送信
public void SetTag (string name);
パラメータ
| 項目名 | 詳細 |
|---|---|
| name | タグ名 |
タグと任意の値の送信
public void SetTag (string name, string value);
パラメータ
| 項目名 | 詳細 |
|---|---|
| name | タグ名 |
| value | タグに持たせる値 |
バッチクリア (iOSのみ)
配信時に、バッチにチェックマークを付けた場合、バッチをクリアするためのメソッドです。 iOSのみ利用できます。
public void ClearBadge ();
チャンネルIDをセット
Android 8.0以上のみ。 任意の通知チャンネルで、通知を受け取れるように変更します。
public void SetChannelId(string channelId);
パラメーター |項目名|詳細| |:–|:–| |channelId|チャンネルID|
デフォルト通知チャンネルの削除
Android 8.0以上のみ。 SDKのデフォルトの通知チャンネルを削除します。 ※ Growth Push初期化時に、channel_idがセットされていない場合、再度作成されます。
public void DeleteDefaultNotificationChannel();