Version 1.2.7

Growthbeat API

Growthbeatインスタンスの取得

Growthbeatインスタンスを取得します。

+ (instancetype)sharedInstance;

初期化

Growthbeatの初期化を行います。初期化では以下の処理が行われます。

• デバイス登録、認証
• Growth Push、Growth Analytics、Growth Messageの初期化（Growth Linkは別途初期化が必要）
• 基本情報の送信

- (void)initializeWithApplicationId:(NSString *)applicationId credentialId:(NSString *)credentialId;

パラメータ

- (void)initializeWithApplicationId:(NSString *)applicationId credentialId:(NSString *)credentialId adInfoEnable:(BOOL)adInfoEnable;

パラメータ

起動イベントの送信

アプリケーションの起動イベントを送信します。

- (void)start;

終了イベントの送信

アプリケーションの起動イベントを送信します。

- (void)stop;

ログの停止

Growthbeat SDKからのログ出力を全て停止します。 デフォルトでは、ログ出力がおこなわれます。

- (void) setLoggerSilent:(BOOL silent);

パラメータ

GrowthbeatユニークIDを取得する

SDK初期化時に作成される、GrowthbeatのユニークIDを取得できます。

- (void)getClient:(void(^)(GBClient *client))callback;

IntentHandlerを追加する。

[[GrowthbeatCore sharedInstance] addIntentHandler:[[GBCustomIntentHandler alloc] initWithBlock:^BOOL(GBCustomIntent *customIntent) {
        NSDictionary *extra = customIntent.extra;
        NSLog(@"extra: %@", extra);
        return YES;
}]];

Growth Analytics API

GrowthAnalyticsインスタンスの取得

GrowthAnalyticsインスタンスを取得します。

+ (instancetype)sharedInstance;

基本タグの送信

端末の基本情報を送信します。基本情報には以下が含まれます。

• デバイスモデル
• OS
• 言語
• タイムゾーン
• タイムゾーンオフセット
• アプリバージョン
• 広告ID（Android:AdvertisingId, iOS:IDFA）
• 広告利用可否

- (void)setBasicTags;

特定のイベントを送信

起動イベント

ユーザーの起動イベントを送信します。セッション時間の計測を開始するために必要なメソッドです。

- (void)open;

終了イベント

アプリの終了イベントを送信します。セッション時間の計測を停止します。

- (void)close;

購入イベント

課金時にメソッドを呼び、課金額、アイテムのカテゴリなどを送信することができます。

- (void)purchase:(int)price setCategory:(NSString *)category setProduct:(NSString *)product;

パラメータ

特定のタグを送信

ユーザーIDタグ

アプリのユニークなユーザーIDを送信します。

- (void)setUserId:(NSString *)userId;

パラメータ

名前タグ

アプリのユーザー名を送信します。

- (void)setName:(NSString *)name;

パラメータ

年齢タグ

アプリのユーザーの年齢を送信します。

- (void)setAge:(int)age;

パラメータ

性別タグ

変数は、GAGenderを用いてどちらか性別を送信してください。

- (void)setGender:(GAGender)gender;

パラメータ

レベルタグ

アプリのユーザーのレベルを送信します。

- (void)setLevel:(int)level;

パラメータ

開発用タグ

開発用のフラグををつけます。

- (void)setDevelopment:(BOOL)development;

パラメータ

乱数タグ

乱数を端末の情報として紐付けます。

- (void)setRandom;

カスタムイベント送信

イベントの送信

- (void)track:(NSString *)name;

パラメータ

イベント名と任意のMapの送信

- (void)track:(NSString *)name properties:(NSDictionary *)properties;

パラメータ

イベント名とイベント取得回数オプションの送信

- (void)track:(NSString *)name option:(GATrackOption)option;

パラメータ

option

イベント名と任意のMapの送信とイベント取得回数オプションの送信

- (void)track:(NSString *)name properties:(NSDictionary *)properties option:(GATrackOption)option;

パラメータ

option

カスタムタグ送信

タグの送信

- (void)tag:(NSString *)name;

パラメータ

タグと任意の値を送信

- (void)tag:(NSString *)name value:(NSString *)value;

パラメータ

フルカスタマイズなイベントの送信

特定のネームスペース、イベントIDを設定していただくことが可能です。

- (void)track:(NSString *)_namespace name:(NSString *)name properties:(NSDictionary *)properties option:(GATrackOption)option completion:(void(^)(GAClientEvent * clientEvent))completion;

パラメータ

option

フルカスタマイズなタグの送信

特定のネームスペース、タグIDを設定していただくことが可能です。

- (void)tag:(NSString *)_namespace name:(NSString *)name value:(NSString *)value completion:(void(^)(GAClientTag * clientTag))completion;

パラメータ

Growth Push API

GrowthPushインスタンスの取得

GrowthPushインスタンスを取得します。

+ (instancetype)sharedInstance;

デバイストークンの取得・送信

デバイストークンの取得

- (void)requestDeviceTokenWithEnvironment:(GPEnvironment)newEnvironment;

このメソッドを実行すると、アプリ初回起動時に、プッシュ通知の許可ダイアログが表示されます。

デバイストークンの送信

- (void)setDeviceToken:(id)deviceToken;

AppDelegateクラス

- (void) application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken

のメソッドで上記を必ず実装してください。

プッシュ通知の有効・無効を判定

- (BOOL)enableNotification;

基本タグの送信

Device, OS, Language, Time Zone, Version, Buildが含まれます。

- (void)setDeviceTags;

イベントの送信（Push専用）

イベントの送信（Push専用）

- (void)trackEvent:(NSString *)name;

パラメータ

イベントと任意の値の送信（Push専用）

- (void)trackEvent:(NSString *)name value:(NSString *)value;

パラメータ

タグの送信（Push専用）

タグの送信（Push専用）

- (void)setTag:(NSString *)name;

パラメータ

タグと任意の値の送信（Push専用）

- (void)setTag:(NSString *)name value:(NSString *)value;

パラメータ

バッチクリア

配信時に、バッチにチェックマークを付けた場合、バッチをクリアするためのメソッドです。 iOSのみ利用できます。

- (void)clearBadge;

Growth Message API

GrowthMessageインスタンスの取得

GrowthMessageインスタンスを取得します。

+ (instancetype)sharedInstance;

Growth Link API

GrowthLinkインスタンスの取得

GrowthLinkインスタンスを取得します。

+ (instancetype)sharedInstance;

Growth Linkの初期化

Growthbeatへデバイス登録・認証を行います。

- (void)initializeWithApplicationId:(NSString *)applicationId APPLICATION_ID:(NSString *)credentialId;

パラメータ