iOSのアプリイベントスタートガイド

このガイドでは、Facebook SDKを統合してアプリイベントを記録することにより、新規または既存のアプリにアプリイベントを追加する方法について説明します。

開始する前に

以下の情報が必要です。

• Facebook開発者アカウント
• Facebook広告アカウント
• Facebookビジネスポートフォリオ(ビジネスポートフォリオがない場合は新しく作成してください)
• Facebookアプリ

ステップ1: Facebookアプリを構成する

アプリをまだ作成していない場合は、アプリダッシュボードにアクセスし、[マイアプリ]をクリックしてアプリを新規作成します。[設定] > [基本]をクリックして[アプリの詳細]パネルを開きます。ここには、アプリID、app secret、アプリに関するその他の情報が表示されます。

ページの下部までスクロールして[プラットフォームを追加]をクリックします。[iOS]を選択し、アプリの詳細を追加して、変更を保存します。

広告用にアプリを設定するため、以下の詳細を設定します。

• アプリドメイン - アプリのApple App Store URLを入力します。
• プライバシーポリシーのURL - プライバシーポリシーのURLを入力します。アプリを公開するには入力必須です。
• 利用規約のURL - 利用規約のURLを入力します。
• プラットフォーム - 設定パネルの一番下までスクロールして、iOSプラットフォームを追加します。

アプリにアイコンやカテゴリなどの詳細を追加する方法について詳しくは、アプリ開発のドキュメントを参照してください。

ステップ2: 広告とビジネスポートフォリオをリンクする

広告を掲載して広告マネージャでインストール数を測定するには、1つ以上の広告アカウントと1つのビジネスポートフォリオをアプリに関連付けます。

1. アプリダッシュボードで、[設定] > [詳細]をクリックします。
2. [認証済み広告アカウントID]で、広告アカウントIDを追加します。広告アカウントIDは広告マネージャから取得できます。
3. [広告アカウント]パネルで、[始める]をクリックし、指示に従ってアプリをビジネスにリンクさせます。

ステップ3: 開発環境を設定する

以下の手順では、Swift Package Managerを使用してXcodeの開発環境を設定します。

1. Xcodeで、[ファイル] > [パッケージを追加...]の順にクリックします。
2. 表示される検索フィールドで、リポジトリURL: https://github.com/facebook/facebook-ios-sdkを入力します。
3. [依存ルール]で[次のメジャーバージョンまで]を選び、最新バージョンを入力します。最新リリースは、https://github.com/facebook/facebook-ios-sdk/releases/に示されています
4. 使うライブラリとそれらのライブラリの追加先ターゲットを選びます。
5. [パッケージを追加]をクリックすれば、設定作業は完了です。

ステップ4: アプリをFacebookに登録、設定する

1. アプリダッシュボードの[アプリ設定] > [基本]で、スクロールダウンして[+ プラットフォームを追加]をクリックします。
2. iOSカードまでスクロールダウンして、バンドルIDを追加します。バンドルIDは、XcodeプロジェクトのiOSアプリターゲットで確認できます。バンドルIDはいつでも更新できます。

ステップ5: プロジェクトを構成する

ステップ6: アプリデリゲートとシーンデリゲートを接続する

  
// AppDelegate.swift
import UIKit
import FBSDKCoreKit

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {    
    func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {          
        ApplicationDelegate.shared.application(
            application,
            didFinishLaunchingWithOptions: launchOptions
        )

        return true
    }
          
    func application(
        _ app: UIApplication,
        open url: URL,
        options: [UIApplication.OpenURLOptionsKey : Any] = [:]
    ) -> Bool {
        ApplicationDelegate.shared.application(
            app,
            open: url,
            sourceApplication: options[UIApplication.OpenURLOptionsKey.sourceApplication] as? String,
            annotation: options[UIApplication.OpenURLOptionsKey.annotation]
        )
    }  
}

 
// SceneDelegate.swift
import FBSDKCoreKit
  ...
func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    guard let url = URLContexts.first?.url else {
        return
    }

    ApplicationDelegate.shared.application(
        UIApplication.shared,
        open: url,
        sourceApplication: nil,
        annotation: [UIApplication.OpenURLOptionsKey.annotation]
    )
}

ステップ7: アプリイベントを追加する

アプリでイベントをトラッキングする方法は3とおりあります。

• 自動で記録されるイベント - アプリのインストール、起動、アプリ内購入は、Facebook SDKで自動的にログ記録されます。
• コードレスアプリイベントツール - このツールを使用すると、コードをアプリに追加せずに標準イベントを追加できます。
• 手動で記録されるイベント - コードをアプリに追加して、標準イベントとカスタムイベントをトラッキングします。

イベント自動記録

アプリ内購入でのイベント自動記録

Appleは、消耗品、非消耗品、自動更新可能サブスクリプション、非更新サブスクリプションの4種類のアプリ内購入を提供しています。StoreKit 1でアプリ内購入を実装する場合、アプリ内購入は、これらの種類ごとに自動的に記録されます。StoreKit 2でアプリ内購入を実装する場合、非消耗品、自動更新可能サブスクリプション、非更新サブスクリプションが自動的に記録されます。消耗品も自動的に記録するには、Info.plistにSKIncludeConsumableInAppPurchaseHistoryのキーを追加する必要があります。

<key>SKIncludeConsumableInAppPurchaseHistory</key>

<true/>

StoreKit 1では、ユーザーが商品の購入に成功した場合、商品を復元した場合、または商品の購入を試みて購入に失敗した場合に、イベントが自動的に記録されます。Store Kit 2では、ユーザーが商品の購入に成功した場合、または商品を復元した場合に、イベントが自動的に記録されます。Store Kit 2で購入に失敗した際にもログに記録する場合には、呼び出す必要のある手動APIが用意されています。このAPIは、StoreKit 2購入フローで以下のように呼び出すことができます。

do {
   let result = try await product.purchase()
   switch result {
   case .success(let verificationResult):
       // Handle success case
   case .pending:
       // Handle pending case
   default:
       AppEvents.shared.logFailedStoreKit2Purchase(product.id)
   }
} catch {
   AppEvents.shared.logFailedStoreKit2Purchase(product.id)
}

デバイスの同意を取得する

iOS 14.5以降では、isAdvertiserTrackingEnabledを設定し、Facebookとデータを共有するためのデバイスアクセス許可を与えるたびにログ記録する必要があります。

デバイスから同意が取得できたら、Settings.shared.isAdvertiserTrackingEnabled = trueを設定します。

デバイスがトラッキングを許可しなかった場合は、Settings.shared.isAdvertiserTrackingEnabled = falseを設定します。

<key>FacebookAutoLogAppEventsEnabled</key>
<false/>

<key>FacebookAdvertiserIDCollectionEnabled</key>
<false/>

手動でイベントを記録する

カスタムイベントを記録するには、イベントの名前をAppEvents.Nameとして渡します。

AppEvents.shared.logEvent(AppEvents.Name("battledAnOrc"))

イベントパラメーター

Metaは、標準イベントや独自のカスタムイベントで使用できる便利なイベントパラメーターのセットを作成しました。独自のパラメーターを指定することもできます。

アプリイベントを使ってダイナミック広告のコンバージョンを測定する場合は、fb_content_idパラメーターを関連するダイナミック広告で使う製品IDの値に設定してください。

定義済みパラメーターは、一般的なログ記録パターンのガイダンスとして提供されています。レポートやその他のUIでもっと読みやすい形式にすることもできます。詳細を確認するパラメーターのセットを記録します。これらのパラメーターで推奨されている説明はあくまでもガイダンスです。アプリにとって意味があるものであれば、パラメーターをどのような用途にも使用できます。

パラメーターはディクショナリを介して渡されます。キーはパラメーター名をAppEvents.ParameterNameとして保持します。値はStringまたは数値(Int、Doubleなど)のいずれかでなければなりません。

ステップ8: イベントをテストする

アプリ広告ヘルパーを使用すると、アプリのアプリイベントをテストして、アプリがFacebookにイベントを送信していることを確認できます。

1. [アプリ広告ヘルパー]を開きます。
2. [アプリを選択]でアプリを選択し、[送信]を選択します。
3. 下部にまでスクロールし、[イベントのテスト]を選択します。
4. アプリを起動し、イベントを送信します。イベントがページに表示されるはずです。

詳しくはこちら

• ベストプラクティスガイド - さまざまなサンプルアプリと、それらの各アプリがどのようにアプリイベントを処理するかを確認します。
• FAQ - よくある質問を確認します。
• Meta Blueprintコース: iOS用SDKとアプリイベントの設定
• Meta Blueprintコース: アプリイベントを使用してターゲット設定、最適化、測定する

アプリの例

さまざまな種類のアプリの例を示して、アプリイベントの使い方を簡単に理解できるようにします。それぞれのアプリの例では、収集可能なさまざまなイベントとパラメーターを画面ごとに詳細に説明しています。各セクションの終わりには、アプリごとに推奨されるイベントとパラメーターを示す表があります。必要に応じて、独自のイベントとパラメーターを作成することもできます。