Places UI キット コンポーネントにアナリティクスを追加する

ユーザーが [経路案内]、[通話]、[ウェブサイト] をタップした、Google マップを開いた、評価や作成者の帰属情報をタップした、写真のライトボックスを開いた、タブを切り替えた、などのアナリティクス イベントを登録できます。各イベントには、起動されたコンポーネントとコンテンツ タイプ、プレイス ID、場所が表示されます。

提供されるアナリティクス イベント

次の表に、Places UI キットで提供されるアナリティクス イベントの例を示します。

UI の操作 tags: Set<String> 関連コンテンツ / コンテンツ タイプ
[経路案内] ボタン {"click", "directions", "outbound"} "main_action_button" または "corner_action_button"
[マップで開く] ボタン {"click", "maps", "outbound"} "main_action_button" または "corner_action_button"
通話ボタン / 電話番号([概要] タブ) {"click", "call_place", "outbound"} "phone_number"、"main_action_button"、"corner_action_button"のいずれか
ウェブサイト ボタン / ウェブサイト([概要] タブ) {"click", "place_website", "outbound"} "website"、"main_action_button"、"corner_action_button"のいずれか
アトリビューション リンク {"click", "attribution", "outbound"} "review" または "media"
評価リンク {"click", "reviews", "outbound"} "rating" または "review_summaries"
法的開示リンク(ⓘ ダイアログ リンク) {"click", "disclosure", "outbound"} null(構成不可)
レポートのリンク {"click", "report", "outbound"} "media"、"review"、"generative_summary"のいずれか
レビューのリンク {"click", "review", "outbound"} "review"
メディア / 写真のリンク {"click", "media", "outbound"} "media"
写真のライトボックスが開いた(アプリ内) {"click", "media"} "media"
[概要] タブが選択されている(アプリ内) {"click", "overview_tab"} null
[レビュー] タブが選択されている(アプリ内) {"click", "reviews_tab"} "review"
[概要] タブが選択された状態(アプリ内) {"click", "about_tab"} "features"
クチコミのオーバーフロー メニュー(⋮)を開いた(アプリ内) {"click", "reviews_menu"} "review"
ライトボックスのオーバーフロー メニュー(⋮)が開いた(アプリ内) {"click", "lightbox_menu"} "media"
生成 AI による要約メニュー(⋮)が開いている(アプリ内) {"click", "generative_summary_menu"} "generative_summary"
生成 AI によるクチコミの要約メニュー(⋮)を開いた(アプリ内) {"click", "review_summary_menu"} "review"

新しいイベントやタグが時間の経過とともに追加される可能性があるため、開発中に汎用ハンドラをアタッチして、コンポーネントを操作するときにブロードキャストされるすべてのイベントをログに記録できます。

// Attach to a Places UI Kit view or a parent container to inspect all broadcast events
.onPlaceAnalyticsEvent { event in
  print(
    "Analytics event — component: \(event.componentType), " +
    "tags: \(event.tags.sorted()), " +
    "content: \(event.contentType ?? "nil"), " +
    "places: \(event.places.compactMap(\.placeID))"
  )
}

アナリティクス イベントを登録して処理する

onPlaceAnalyticsEvent 修飾子を使用して、UI Kit コンポーネントから分析イベントをサブスクライブできます。修飾子は、コンテナビューまたは UI Kit コンポーネントに直接アタッチできます。

次のコードは、コンテナビュー内でアナリティクス イベントをサブスクライブして処理する方法を示しています。

import SwiftUI
import PlacesSwift

struct PlaceCardScreen: View {
  @State private var query = PlaceDetailsQuery(identifier: .placeID("ChIJN1t_tDeuEmsRUsoyG83frY4"))
  var configuration: PlaceDetailsCompactConfiguration {
    return PlaceDetailsCompactConfiguration(
      content: PlaceDetailsCompactView.standardContent,
      theme: PlacesMaterialTheme()
    )
  }

  var body: some View {
    VStack {
      PlaceDetailsCompactView(query: $query, configuration: configuration, placeDetailsCallback: { _ in })
        // 1. Direct card tap (for UI navigation, e.g., centering a map)
        .onTap { place in
          print("Card tapped for place ID: \(place.placeID ?? "unknown")")
        }
    }
    // 2. Analytics callback (can be attached to the card or any parent container)
    .onPlaceAnalyticsEvent { event in
      let placeID = event.places.first?.placeID ?? "none"

      // Option A: Check for specific interactions using built-in Tag constants
      if event.tags.contains(PlaceAnalyticsEvent.Tag.directions) {
        print("User requested directions for place: \(placeID)")
      }

      if event.tags.contains(PlaceAnalyticsEvent.Tag.outbound) {
        print("User is leaving the app via: \(event.tags.sorted().joined(separator: ", "))")
      }

      // Option B: Forward every event directly to your analytics SDK (e.g., Firebase)
      Analytics.logEvent("place_ui_kit_interaction", parameters: [
        "component_type": event.componentType,
        "content_type": event.contentType ?? "none",
        "tags": event.tags.sorted().joined(separator: ","),
        "place_id": placeID
      ])
    }
  }
}

アプリで同じウィジェット タイプの複数のカード(2 つの PlaceDetailsCompactView インスタンスなど)が表示される場合、.onPlaceAnalyticsEvent を各ビューに直接アタッチすると、イベントをトリガーした特定のカード インスタンスを把握できます。

次のコード スニペットは、AdvancedPlaceDetailsCompactView コンポーネントでアナリティクス イベントを直接サブスクライブして処理する方法を示しています。

import SwiftUI
import PlacesSwift

struct SinglePlaceCardView: View {
  @State private var query = PlaceDetailsQuery(
    identifier: .placeID("ChIJN1t_tDeuEmsRUsoyG83frY4")
  )
  private var configuration: AdvancedPlaceDetailsCompactConfiguration {
    AdvancedPlaceDetailsCompactConfiguration(
      content: AdvancedPlaceDetailsCompactView.standardContent,
      theme: PlacesMaterialTheme()
    )
  }

  var body: some View {
    AdvancedPlaceDetailsCompactView(
      orientation: .horizontal,
      query: $query,
      configuration: configuration
    ) { _ in }
      // 1. Direct card-tap callback (must come before generic `View` modifiers)
      .onTap { place in
        print("Tapped card for place: \(place.placeID ?? "unknown")")
      }
      // 2. Analytics callback scoped to this specific view instance
      .onPlaceAnalyticsEvent { event in
        let placeIDs = event.places.compactMap(\.placeID).joined(separator: ", ")
        let tags = event.tags.sorted().joined(separator: ", ")

        print("[\(tags)] in \(event.componentType), content: \(event.contentType ?? "nil"), places: [\(placeIDs)]")

        if event.tags.contains(PlaceAnalyticsEvent.Tag.directions) {
          print("Directions tapped on this card")
        }
      }
  }
}

カードタップ コールバックを追加して処理する

カードタップ コールバックは、UI Kit コンポーネントごとに個別に設定して処理する必要があります。

UI キット コンポーネントで .onTap 修飾子を使用して、カード本体のタップを処理します。ユーザーがカードをタップすると、.onTap は 3 つのプロパティが入力された Place 構造体を渡します。

  • place.placeID(String?): 完全な PlaceDetailsView シートを開く、マーカーを選択するなどの操作を行うための一意のプレイス ID。
  • place.location(CLLocationCoordinate2D): 地図カメラの中心に配置する場所や、マーカーを配置する場所の緯度 / 経度座標。
  • place.viewportInfo(RectangularCoordinateRegion?): 地図上で場所をフレームに収めるための、推奨される地図ビューポートの境界(northEast 座標と southWest 座標)。

次のコードは、AdvancedPlaceDetailsCompactView のカードタップ コールバックを追加して処理する方法を示しています。

import CoreLocation
import PlacesSwift
import SwiftUI

struct PlaceCardTapSampleView: View {
  static let peetsCoffeePlaceID = "ChIJT7FdmYiAhYAROFOvrIxRJDU"

  @State private var query = PlaceDetailsQuery(
    identifier: .placeID(peetsCoffeePlaceID)
  )
  @State private var selectedPlace: Place?

  var body: some View {
    AdvancedPlaceDetailsCompactView(
      orientation: .horizontal,
      query: $query,
      configuration: AdvancedPlaceDetailsCompactConfiguration(
        content: AdvancedPlaceDetailsCompactView.standardContent,
        theme: PlacesMaterialTheme()
      ),
      placeDetailsCallback: { _ in }
    )
    .onTap { place in
      // Handle the card tap using place.placeID, place.location, or place.viewportInfo
      selectedPlace = place
      print("Tapped place ID: \(place.placeID ?? "unknown")")
      print("Coordinates: \(place.location.latitude), \(place.location.longitude)")

      if let viewport = place.viewportInfo {
        print("Viewport NE: \(viewport.northEast), SW: \(viewport.southWest)")
      }
    }
  }
}