iOS 用ユニバーサルピクセル SDK

[アーティクル]
02/23/2024

この記事では、パブリッシャーが iOS 用ユニバーサルピクセル SDK (Pixie SDK) を統合してインストールする方法について説明します。

統合手順

要件

SDK には、次のコンポーネントが必要です。

macOS Mojave 10.14.4 以降
iOS 9 以降
Swift 5+
Xcode 11 以降

Pixie SDK を使用するには、有効な Xandr Unified Pixel ID が必要です。これは、アプリ内のピクセルを表す英数字 ID です。

インストールガイド

SDK をインストールするには、次の 2 つの方法があります。

CocoaPods の使用

CocoaPods は、Cocoa プロジェクトの依存関係マネージャーです。 CocoaPods に慣れていない場合は、インストールとユーザーガイドを確認してください。
1. CocoaPods をインストールしたら、ターミナルまたは任意のコマンドラインエディターを使用して、プロジェクトのルートディレクトリに移動し、ポッドファイルを作成します。
```
pod init
```
2. テキストエディターを使用して、新しく作成した podfile を開きます。プラットフォームのバージョンを 9.0 に設定し、ターゲットにポッド PixieSDK を追加します。
```
# iOS: Podfile config to include our SDK
platform :ios, '9.0'
project 'SampleApp'
target 'SampleApp' do
  pod 'PixieSDK'
end
```
3. 変更を保存し、 ターミナル に戻り、次のように入力します。
```
pod install
```
4. CocoaPods は Pixie SDK をダウンロードし、プロジェクトディレクトリにワークスペースを作成します。プロジェクトが現在開いている場合は、プロジェクトを閉じてワークスペースを開きます。
Xandr Unified Pixel SDK XCFramework の使用

注:

PixieSDK.xcframework を配布しています。ここからダウンロードできます。ファイルをダウンロードし、 Frameworks フォルダーに追加します。

Frameworks フォルダーを作成します。

プロジェクトナビゲーター (最上位のエントリ) でプロジェクトを右クリックし、[ 新しいグループ] を選択します。新しいグループに Frameworks という名前を付けます。
Frameworks フォルダーに追加 PixieSDK.xcframework します。

Finder から Frameworks フォルダーにドラッグアンドドロップPixieSDK.xcframeworkします。ドラッグ先がフレームワークのすぐ下にあることを確認 します。
[必要に応 じて項目をコピー する] オプションと [ グループの作成] がオンになっており、ファイルを追加するために選択されていることを確認します。 [完了] をクリックします。
この手順が完了すると、結果は次のように表示されます。
プロジェクトのターゲットに埋め込まれた PixieSDK.xcframework
プロジェクトナビゲーターでプロジェクト設定をクリックして、プロジェクト設定に移動します。
ターゲットが選択され、[ 全般 ] タブが開いていることを確認します。
新しく追加した XCFramework の [埋め込み & 署名 ] を選択します。

実装ガイド

SDK の初期化

アプリデリゲートのファイル内の didFinishLaunchingWithOptions メソッド内でその initialize メソッドを呼び出す SDK を初期化します。

Pixie.initialize(pixelId:String)`

イベントの追跡

SDK が初期化されると、fireEvent メソッドを使用してイベントを追跡および送信できます。

注:

初期化前に追跡されているイベントはすべて拒否されます。

Pixie.fireEvent(eventName : String, eventParams : PixieParams?)

fireEvent メソッドは 、イベント文字列 と PixieParams(省略可能) を受け取ります。これらはパラメーターです。

eventName:String

標準イベント文字列は、Event クラス内で定義されます。使用可能な標準イベント文字列については、以下の「標準イベント」セクションを参照してください。また、ユニバーサルピクセル UI でカスタムイベント文字列を定義し、アプリケーションで使用することもできます。

カスタムイベント文字列は、ユニバーサルピクセル UI を使用して事前登録する必要があります。

eventParams:PixieParams

イベントデータは PixieParams クラスによって表されます。すべてのパラメーターは省略可能です。

注:

パラメーターが渡されない場合は、Objective C を使用している場合でも nil オブジェクトを送信する必要があります。

名前	説明
プロパティ
currency : 文字列	指定したの `value` 通貨。
itemId : 文字列	表される項目のジェネリック ID。 ID は、コンマ区切り項目の配列として渡すこともできます。例: "itemId1, itemId2"
itemName : String	表される項目の名前。名前は、コンマ区切り項目の配列として渡すこともできます。例: "itemName1, itemName2"
itemType : 文字列	表される項目のジェネリック型。型は、コンマ区切り項目の配列として渡すこともできます。例: "itemType1, itemType2"
value : String	このイベントをビジネスに対して実行するユーザーの価値。
機能
put (key : String, value : String)	パブリッシャーによって定義された任意のデータ。キーと値のペアを使用したカスタムイベントデータの渡しを有効にします。キーは、ユニバーサルピクセル UI を使用して事前登録する必要があります。値には、コンマで区切られた配列を指定できます。詳細については、以下の「カスタムイベント」セクションを参照してください。

コードサンプル

初期化コードサンプル

Swift

import PixieSDK
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        Pixie.initialize("b63be84e-d95b-4c67-8242-d9c9c026ed30")
        return true
        }

目標 C

@import PixieSDK;
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [Pixie initialize:@"b63be84e-d95b-4c67-8242-d9c9c026ed30"];
    return YES;
}

ページビューの追跡

Event.PAGE_VIEW`

アクセスされた特定のページ。

コードサンプル

Swift

Pixie.fireEvent(Event.PAGE_VIEW)

目標 C

[Pixie fireEvent:Event.PAGE_VIEW eventParams:nil];

ランディングページビューを追跡する

Event.LANDING_PAGE`

ランディングページビューを追跡する。

コードサンプル

Swift

let landingPageParams = PixieParams(value: "5.99", currency: "USD", itemId: "product_5,product_6", itemType: "apparel,accessory", itemName: "shirt,belt")
Pixie.fireEvent(Event.LANDING_PAGE, eventParams:landingPageParams)

目標 C

PixieParams *landingPageParams = [[PixieParams alloc] initWithValue:@"5.99" currency:@"USD" itemId:@"product_5,product_6" itemType:@"apparel,accessory" itemName:@"shirt,belt"]; [Pixie fireEvent:Event.LANDING_PAGE eventParams:landingPageParams];

アイテムビューを追跡する

Event.ITEM_VIEW`

キーページビューを追跡します (たとえば、製品ページ、ランディングページ、記事)。

コードサンプル

Swift

let itemViewParams = PixieParams(value: "5.99", currency: "USD", itemId: "product_5,product_6", itemType: "apparel,accessory", itemName: "shirt,belt")
               Pixie.fireEvent(Event.ITEM_VIEW, eventParams:itemViewParams)

目標 C

PixieParams *itemViewParams = [[PixieParams alloc] initWithValue:@"5.99" currency:@"USD" itemId:@"product_5,product_6" itemType:@"apparel,accessory" itemName:@"shirt,belt"];
[Pixie fireEvent:Event.ITEM_VIEW eventParams:itemViewParams];

カートへの追加イベントを追跡する

Event.ADD_TO_CART`

アイテムがショッピングカートに追加されたタイミングを追跡します (たとえば、[カートに追加] ボタンのクリック、ランディングページなど)。

コードサンプル

Swift

let addToCartParams = PixieParams(value: "5.99", currency: "USD", itemId: "product_5,product_6", itemType: "apparel,accessory", itemName: "shirt,belt")
               Pixie.fireEvent(Event.ADD_TO_CART, eventParams:addToCartParams)

目標 C

PixieParams *addToCartParams = [[PixieParams alloc] initWithValue:@"5.99" currency:@"USD" itemId:@"product_5,product_6" itemType:@"apparel,accessory" itemName:@"shirt,belt"];
[Pixie fireEvent:Event.ADD_TO_CART eventParams:addToCartParams];

チェックアウトの開始を追跡する

Event.INITIATE_CHECKOUT

ユーザーがチェックアウトフローに入ったタイミングを追跡します (たとえば、チェックアウトボタンのクリック、ランディングページなど)。

コードサンプル

Swift

let initiateCheckOutParams = PixieParams(value: "5.99", currency: "USD", itemId: "product_5,product_6", itemType: "apparel,accessory", itemName: "shirt,belt")
               Pixie.fireEvent(Event.INITIATE_CHECKOUT, eventParams: initiateCheckOutParams)

目標 C

PixieParams *initiateCheckOutParams = [[PixieParams alloc] initWithValue:@"5.99" currency:@"USD" itemId:@"product_5,product_6" itemType:@"apparel,accessory" itemName:@"shirt,belt"];
[Pixie fireEvent:Event.INITIATE_CHECKOUT eventParams:initiateCheckOutParams];

支払い情報の追加イベントを追跡する

Event.ADD_PAYMENT_INFO`

支払い情報がチェックアウトフローに追加されたタイミングを追跡します (たとえば、請求情報のランディングページをクリックします)。

コードサンプル

Swift

let addPaymentInfoParams = PixieParams(value: "5.99", currency: "USD", itemId: "product_5,product_6", itemType: "apparel,accessory", itemName: "shirt,belt")
               Pixie.fireEvent(Event.ADD_PAYMENT_INFO, eventParams: addPaymentInfoParams)

目標 C

PixieParams *addPaymentInfo = [[PixieParams alloc] initWithValue:@"5.99" currency:@"USD" itemId:@"product_5,product_6" itemType:@"apparel,accessory" itemName:@"shirt,belt"];
[Pixie fireEvent:Event.ADD_PAYMENT_INFO eventParams:addPaymentInfo];

購入の追跡

Event.PURCHASE`

購入またはチェックアウトフローの完了を追跡します (例: [ありがとう ] ページまたは [確認] ページにランディングします)。

コードサンプル

Swift

let purchaseParams = PixieParams(value: "5.99", currency: "USD", itemId: "product_5,product_6", itemType: "apparel,accessory", itemName: "shirt,belt") 
   Pixie.fireEvent(Event.PURCHASE, eventParams: purchaseParams)

目標 C

PixieParams *purchaseParams = [[PixieParams alloc] initWithValue:@"5.99" currency:@"USD" itemId:@"product_5,product_6" itemType:@"apparel,accessory" itemName:@"shirt,belt"];
[Pixie fireEvent:Event.PURCHASE eventParams:purchaseParams];

潜在顧客を追跡する

Event.LEAD

誰かがオファリングに関心を示すタイミングを追跡します (フォームの提出、試用版へのサインアップ、登録など)。

コードサンプル

Swift

let leadParams = PixieParams(value: "5.99", currency: "USD")
Pixie.fireEvent(Event.LEAD, eventParams: leadParams)

目標 C

PixieParams *leadParams = [[PixieParams alloc] init];
leadParams.value = @"5.99";
leadParams.currency = @"USD";
[Pixie fireEvent:Event.LEAD eventParams:leadParams];

カスタムイベントを追跡する

カスタムイベントを使用すると、パブリッシャーは独自のイベントを作成して追跡および送信できます。カスタムイベントを作成するには、送信するデータを含む PixelParams オブジェクトを開始し、そのオブジェクトを Pixie SDK fireEvent メソッドに文字列識別子と共に渡します。 PixelParams オブジェクトの put メソッドを使用して、カスタムイベントデータをキーと値のペアで送信することもできます。

コードサンプル

Swift

let customPixieParams = PixieParams()
customPixieParams.value = "5.99"
customPixieParams.itemName = "shirt,belt"
//passing key value pairs with the put method
customPixieParams.put("name", "Form Submission")
customPixieParams.put("email", "user@appnexus.com")
customPixieParams.put("type", "subscribe,newuser")
Pixie.fireEvent("TestCustomEvent", eventParams: customPixieParams) ```

目標 C

PixieParams *customPixieParams = [[PixieParams alloc] init];
customPixieParams.value = @"5.99";
customPixieParams.itemName = @"shirt,belt";
//passing key value pairs with the put method
[customPixieParams put:@"name" :@"Form Submission"];
[customPixieParams put:@"email" :@"user@appnexus.com"];
[customPixieParams put:@"type" :@"subscribe,newuser"];
[Pixie fireEvent:@"TestCustomEvent" eventParams:customPixieParams];

ログ記録を有効にする

Pixie SDK には、開発中のログ記録を可能にするデバッグモード機能が付属しています。これを有効にするには、debugMode 変数を true に設定します。リリースビルドでは、すべてのログ記録が無効になります。

Swift

Pixie.shared.debugMode = true

目標 C

Pixie.shared.debugMode = true;

次の方法で共有

iOS 用ユニバーサルピクセル SDK

統合手順

要件

インストールガイド

実装ガイド

SDK の初期化

イベントの追跡

eventName:String

eventParams:PixieParams

コードサンプル

初期化コードサンプル

ページビューの追跡

コードサンプル

ランディングページビューを追跡する

コードサンプル

アイテムビューを追跡する

コードサンプル

カートへの追加イベントを追跡する

コードサンプル

チェックアウトの開始を追跡する

コードサンプル

支払い情報の追加イベントを追跡する

コードサンプル

購入の追跡

コードサンプル

目標 C

潜在顧客を追跡する

コードサンプル

カスタムイベントを追跡する

コードサンプル

ログ記録を有効にする

その他のリソース

次の方法で共有

iOS 用ユニバーサル ピクセル SDK

統合手順

要件

インストール ガイド

実装ガイド

SDK の初期化

イベントの追跡

eventName:String

eventParams:PixieParams

コード サンプル

初期化コード サンプル

ページ ビューの追跡

コード サンプル

ランディング ページ ビューを追跡する

コード サンプル

アイテム ビューを追跡する

コード サンプル

カートへの追加イベントを追跡する

コード サンプル

チェックアウトの開始を追跡する

コード サンプル

支払い情報の追加イベントを追跡する

コード サンプル

購入の追跡

コード サンプル

目標 C

潜在顧客を追跡する

コード サンプル

カスタム イベントを追跡する

コード サンプル

ログ記録を有効にする

その他のリソース

iOS 用ユニバーサルピクセル SDK

インストールガイド

コードサンプル

初期化コードサンプル

ページビューの追跡

コードサンプル

ランディングページビューを追跡する

コードサンプル

アイテムビューを追跡する

コードサンプル

コードサンプル

コードサンプル

コードサンプル

コードサンプル

コードサンプル

カスタムイベントを追跡する

コードサンプル