ロケーションモジュール

ロケーションモジュールは、iOSアプリが位置情報を受け取り、ジオフェンスを構成し監視する機能を有効にします。詳細を学ぶ 位置追跡とジオフェンシングについて。

サポートされているプラットフォーム

以下のプラットフォームがサポートされています：

• iOS

要件

• Tealium for Swift (1.9.0+)

サンプルアプリ

iOSサンプルアプリを探索して、ライブラリ、トラッキング方法、ベストプラクティスの実装に慣れてください。メインのサンプルアプリにはロケーションモジュールとジオフェンシング機能の例が含まれています。

インストール

Swift Package Manager、CocoaPods、またはCarthageを使用してロケーションモジュールをインストールします。ロケーションモジュールは、位置イベントを送信するためにディスパッチャー（TealiumCollectまたはTealiumTagManagement）を必要とします。

Swift Package Manager (推奨)

バージョン1.9.0+でサポートされているSwift Package Managerは、Tealium Swiftライブラリをインストールする最も簡単で推奨される方法です：

1. Xcodeプロジェクトで、File > Add Package Dependenciesを選択します。
2. リポジトリURLを入力します：https://github.com/tealium/tealium-swift
3. バージョンルールを構成します。通常、Up to next majorが推奨されます。現在のTealium Swiftライブラリバージョンがリストに表示されない場合は、Swiftパッケージキャッシュをリセットします。
4. インストールするモジュールのリストからLocationモジュールを選択し、Xcodeプロジェクトの各アプリターゲットに追加します。Frameworks and Librariesの下にあります。

iOS向けのSwift Package Managerインストールについて詳しく学びます。

CocoaPods

CocoaPodsでロケーションモジュールをインストールするには、次のpodをPodfileに追加します：

pod 'tealium-swift/Location'

iOS向けのCocoaPodsインストールについて詳しく学びます。

Carthage

Carthageでロケーションモジュールをインストールするには：

1. Xcodeでアプリターゲットの一般構成ページに移動します。

2. 次のフレームワークをEmbedded Binariesセクションに追加します：

   TealiumLocation.framework
   

iOS向けのCarthageインストールについて詳しく学びます。

初期化

モジュールを初期化するには、TealiumConfigのcollectorsプロパティで指定されていることを確認します。

config.collectors = [Collectors.Location]

位置精度とジオフェンシングの追加オプションも、TealiumConfigインスタンスで構成可能です。

Collectorsのドキュメンテーションを確認し、必要なコレクターを正しく指定する方法を理解してください。

認証

アプリが位置情報を収集するための認証を行うには、次のキーをアプリのInfo.plistファイルに追加します：

• Privacy - Location When In Use Usage Description
• Privacy - Location Always and When In Use Usage Description

キーが存在しない場合、位置情報のリクエストはすぐに失敗します。詳細を学ぶ 位置情報サービスの認証リクエストについて。

現在の実装でまだ位置情報の認証をリクエストしていない場合は、Tealiumのコールバック内でロケーションモジュールのAPIメソッドrequestAuthorization()を使用できます：

func start() {
      //...
      tealium = Tealium(config: config) { _ in
      		self.tealium?.location?.requestAuthorization()
      }
  }

おおよその位置追跡 (iOS 14+)

Apple iOS 14+では、アプリ構成で正確な位置ではなく、おおよその位置を共有することができます。アプリが正確な位置を必要とし、ユーザーがデバイス構成を通じて最初に正確な位置追跡を無効にした場合、この方法が推奨されます。

すでにコードベースで一時的な完全な認証をリクエストしていない場合は、以下の例に示すようにTealiumのヘルパーメソッドrequestTemporaryFullAccuracyAuthorizationを使用して、一時的な完全な精度をリクエストします。

func start() {
    //...
    tealium = Tealium(config: config) { _ in
      guard let location = self.tealium?.location else {
          return
      }
      if location.isAuthorized {
          location.requestTemporaryFullAccuracyAuthorization(purposeKey: "NearStore")
      } else {
          location.requestAuthorization()
      }
    }
}

StringパラメータpurposeKeyは、アプリのInfo.plistファイルのNSLocationTemporaryUsageDescriptionDictionary辞書のキーに対応しています。以下の例を参照してください：

    <key>NSLocationTemporaryUsageDescriptionDictionary</key>
    <dict>
        <key>NearStore</key>
        <string>In order to send you discounts when you are near a store</string>
    </dict>

一時的な完全な認証のリクエストについて詳しく学びます。

位置追跡

ユーザーが位置情報サービスを認証すると、ロケーションモジュールは連続的な位置追跡を行います。位置の更新は精度と距離の2つの構成に基づいています。

ジオフェンス機能を無効にすると、AppleのstartMonitoringSignificantLocationChanges()メソッドによって重要な位置の更新のみが監視され、更新が少なくなり、バッテリーの消費が少なくなります。このメソッドは、プロパティconfig.geofencesTrackingEnabledまたはconfig.useHighAccuracyのいずれかがfalseに構成されている場合に呼び出されます。それ以外の場合は、AppleのstartUpdatingLocationメソッドが呼び出されます。

ジオフェンス機能はデフォルトで有効になっており、位置の更新はより頻繁に行われ、精度が向上します。より頻繁な位置の更新を有効または無効にするには、useHighAccuracyプロパティを構成します。

より正確な位置と距離の構成が必要な場合は、更新をトリガーするメートル単位の値でupdateDistanceプロパティを構成します。

また、desiredAccuracyという拡張精度構成もあり、これはアプリが受け取りたい精度のレベルを指定します。これはCLLocationManager desiredAccuracyプロパティと同様です。iOS 14+ではデフォルト値は.reducedで、それ以前のバージョンでは.nearestHundredMetersです。

func start() {
      let config = TealiumConfig(account: "ACCOUNT",
                                 profile: "PROFILE",
                                 environment: "ENVIRONMENT",
                                 datasource: "DATASOURCE",
                                 optionalData: nil)
      config.useHighAccuracy = false
      config.updateDistance = 150
      config.desiredAccuracy = .nearestThreeKilometers
  }

ジオフェンシング

ジオフェンシングはデフォルトで有効になっており、ジオフェンスを構成するには、次のいずれかの方法を使用してジオフェンスJSONファイルを提供します：

• ホストされたURL
  自分でホストするジオフェンスファイルを使用し、プロパティgeofenceUrlへのURLとして提供します。 このオプションは、パブリッシュ構成のURLを上書きした場合や、ホストされたデータレイヤーを使用したい場合に推奨されます。

config.geofenceUrl = "https://example.com/geofences.json"

• ローカルファイル
  アプリに保存されたジオフェンスファイルを使用し、プロパティgeofenceFileNameを構成します。ファイル拡張子は省略します。

config.geofenceFileName = "geofences" // geofences.json

ジオフェンシングを無効にするには、geofenceTrackingEnabledプロパティを構成します：

config.geofenceTrackingEnabled = false

追加の考慮事項

アクティブなジオフェンスの数
ジオフェンスは動的に追加および削除され、可能な限り少ないリソースを使用します。ジオフェンスの定義数には制限はありませんが、すべての 実行中のアプリケーションに対してデバイスユーザーごとのアクティブなジオフェンスの数は20に制限されています。

ジオフェンスの初期化
ユーザーがジオフェンスの作成時にその中にいる場合、enterトランジションイベントは発火しません。これは、exitおよびenterトランジションイベントは境界を越えたときに発火し、内部に現れたときには発火しないからです。

データレイヤー

以下の変数は、モバイルデータレイヤーの一部としてロケーションモジュールによって自動的に追加されます。これらの変数は、ライブラリからの各トラッキング呼び出しに自動的に含まれます。

ジオフェンシング中に、ユーザーの遷移状態が変化したときに位置データを含むトラッキング呼び出しが送信されます。遷移状態の変化には、ユーザーがジオフェンスに入るか出ることが含まれます。以下の追加変数がデータレイヤーに送信されます：

APIリファレンス

ロケーションモジュールで使用されるメソッドのリファレンスについては、Tealium SDK for iOS APIのLocationModuleクラスを参照してください。