iOS SDKイベント及び収益トラッキング

Avatar
Dora Kishinevsky
Updated
Singular iOS SDK
ダウンロード Singular iOS SDK version 9.2.8
互換性 iOS 8+
サンプルアプリ Review our sample app for an example of a complete SDK integration based on best practices.
実装ガイド

 

イベントトラッキング

キャンペーン成果の分析、KPI測定を行う為に、Singularを通じてアプリ内のイベントデータを収集する事が可能です。

例えば、ゲームアプリではユーザーログイン、会員登録、チュートリアル完了、レベルアップのようなデータを取集を望む場合もあります。

この場合、eventやeventWithArgsメソッドを使用しSingularにアプリ内イベントを送る事も可能です。

注意:

  • 第三者パートナー及び外部分析ソリューションとの互換性の為にイベント名と属性には英語をご利用ください。
  • イベント名は32文字以下のASCIIキャラクターにて制限されます。ASCIIキャラクターでは無い文字列はUTF-8に変換された場合に32 byte未満である必要があります。
  • 属性の様な値は500字以下のASCIIキャラクターにて制限されます。
event メソッド
定義 トラッキングの為にイベントを追加情報なしにSingularに転送
メソッド +(void)event:(NSString *)name
使用例

Objective-C:

[Singular event:@"login"];

Swift (requires bridging header):

Singular.event("login")
eventWithArgs メソッド
定義 Send a user event to Singular for tracking, with additional information.
メソッド +(void)eventWithArgs:(NSString *)name, ...
使用例

Objective-C:

// ユーザーが商品を閲覧した行動に対するイベントを転送
// 商品シリアル番号と価格を詳細情報に含めた例
[Singular eventWithArgs:@"viewItem",
   @"sku", @"12345",
   @"price", [NSNumber numberWithDouble:123.45], nil];

Swift (requires bridging header):

// ユーザーが商品を閲覧した行動に対するイベントを転送
// 商品シリアル番号と価格を詳細情報に含めた例
Singular.event("viewItem", withArgs: ["sku": "12345",
    "price": "12345"])
event メソッド (NSDictionary 形式のアーギュメント含む)
定義 NSDictionary オブジェクト追加情報を含めイベントをSingularに転送
メソッド + (void) event:(NSString *)name withArgs:(NSDictionary *)args;
使用例

Objective-C:

// カートアップデートイベントをSingularに転送
// NSDictionaryとなっているアイテム詳細を含める例

// まずカート内のアイテムを個別に設定
NSDictionary *item1 = [NSDictionary 
    dictionaryWithObjectsAndKeys:
   @"UPC-018627610014", @"sku",
   [NSNumber numberWithInt:2], @"qty",
   [NSNumber numberWithDouble:8.99], @"unit_price",
   @"USD", @"currency", nil];
NSDictionary *item2 = [NSDictionary
    dictionaryWithObjectsAndKeys:
   @"UPC-070271003758", @"sku",
   [NSNumber numberWithInt:1], @"qty",
   [NSNumber numberWithDouble:15.99], @"unit_price",
   @"USD", @"currency", nil];
NSDictionary *item3 = [NSDictionary
    dictionaryWithObjectsAndKeys:
   @"ISBN13-978-0-596-51774-8", @"sku",
   [NSNumber numberWithInt:1], @"qty",
   [NSNumber numberWithDouble:29.99], @"unit_price",
   @"USD", @"currency", nil];

// アイテム達をcontentsアレイにて束ねる(選択事項)
NSArray *contents = [NSArray arrayWithObjects:item1,
    item2, item3, nil];

// カートイベントにアイテムアレイをcontentsというキー値に含む
// 注意: 簡潔性維持の為に例には総金額をハードコーディングしたものの 
// 実際には合計を計算して送る事が一般的
NSDictionary *args = [NSDictionary
    dictionaryWithObjectsAndKeys:contents,
   @"contents",
   [NSNumber numberWithDouble:63.96], @"total",
   @"USD", @"currency",
   @"A556740089", @"member_id", nil];

// Singularにイベント転送
[Singular event:@"cart" withArgs:args];

収益トラッキング

キャンペーン成果及びROIを分析する為にSingularを通じてアプリ内の収益データを取集する事が可能です。取集する際にはSingularのレポート、ログ抽出、ポストバックを通じて該当データを確認出来ます。

Singularに収益イベントを送る際には iapComplete SDK メソッド使用をおすすめしており、この場合、Appleのアプリ内購入であるIAP収益イベントをSingularに送ります。ここには下記二つの項目が含まれます。

  • 全てのトランザクション詳細事項: Singularがより詳細なレポートを提供する為に必要な様々な情報が含まれます。
  • トランザクションレシート: Singularがバックエンドにて購入を検証する際に活用しフラウド防止にも使用可能です。

注意: 収益を様々な異なる通貨単位で送る場合にもデータの確認しにはSingularのアカウントに設定したお客様の通貨単位にて自動変換され表示されます。

iapComplete メソッド
定義 トランザクションレシートを含みSingularに収益イベント転送
メソッド (void)iapComplete:(id)transaction
(void)iapComplete:(id)transaction withName:(NSString *)name;
使用例

Objective-C:

SKPaymentTransaction* transaction = ...;

// トランザクションイベントをSingularに転送
[Singular iapComplete:transaction];

// カスタム収益イベント名を使用し
// トランザクションイベントをSingularに転送
[Singular iapComplete:transaction
    withName:@"MyCustomRevenue"];

他の方式にて収益イベントを転送

前に述べたiapCompleteにて収益イベントを転送する事がおすすめされるか、他の方式にて収益イベントを転送した場合、revenue又はcustomRevenueを使用する事も可能です。

より詳しく調べる

次に説明するメソッドを使用する場合、トランザクション金額と通貨単位を手動で特定出来、詳細事項も選択的に転送出来ます。 customRevenueを使用するとカスタム収益イベント名も指定可能です。

但し、二つのメソッドともトランザクションレシートを転送しない為、Singularにてトランザクションを検証する事が出来ません。

revenue メソッド
定義 金額と通貨単位及び詳細情報を含めSingularに収益イベントを転送
メソッド (void)revenue:(NSString *)currency amount:(double)amount;
(void)revenue:(NSString *)currency amount:(double)amount productSKU:(NSString *)productSKU productName:(NSString *)productName productCategory:(NSString *)productCategory productQuantity:(int)productQuantity productPrice:(double)productPrice;

注意: 通貨(currency)は3文字となっているISO 4217通貨コードを使用します。例: “USD”, “EUR”, “JPY”
Usage Example

Objective-C:

// 商品の詳細情報を含めずにSingularに収益イベントを転送
[Singular revenue:@"USD" amount:1.99];

// 商品の詳細情報を含めてSingularに収益イベントを転送
[Singular revenue:@"EUR" amount:5.00 productSKU:@"SKU1928375"
productName:@"Reservation Fee" productCategory:@"Fee" 
productQuantity:1 productPrice:5.00];
customRevenue メソッド
定義 金額と通貨単位及び詳細情報を含めてSingularにカスタム名にて収益イベントを転送
メソッド (void)customRevenue:(NSString *)eventName currency:(NSString *)currency amount:(double)amount;
(void)customRevenue:(NSString *)eventName currency:(NSString *)currency amount:(double)amount productSKU:(NSString *)productSKU productName:(NSString *)productName productCategory:(NSString *)productCategory productQuantity:(int)productQuantity productPrice:(double)productPrice;

注意: 通貨(currency)は3文字となっているISO 4217通貨コードを使用します。例: “USD”, “EUR”, “JPY”
Usage Example

Objective-C:

// 商品の詳細情報を含めずにSingularにカスタム名でイベント転送
[Singular customRevenue:@"MyCustomRevenue" currency:@"USD"
amount:1.99];

// 商品の詳細情報を含めてSingularにカスタム名でイベント転送
[Singular customRevenue:@"MyCustomRevenue" currency:@"EUR"
amount:5.00 productSKU:@"SKU1928375"
productName:@"Reservation Fee" productCategory:@"Fee" 
productQuantity:1 productPrice:5.00];