Adicionar análises a um componente do Kit de Interface do Places

Você pode se inscrever em eventos de análise sobre usuários que tocam em "Rotas", "Ligar" ou "Site", abrem o Google Maps, tocam na classificação por estrelas ou na atribuição de um autor, abrem o lightbox de fotos ou trocam de guia. Cada evento informa qual componente e tipo de conteúdo foi acionado, além do ID de lugar e do local.

Eventos do Analytics fornecidos

A tabela a seguir mostra exemplos de eventos de análise fornecidos pelo Kit de Interface do Places.

Interação com a interface tags: Set<String> Conteúdo associado/Tipo de conteúdo
Botão "Rotas" {"click", "directions", "outbound"} "main_action_button" ou "corner_action_button"
Botão "Abrir no Maps" {"click", "maps", "outbound"} "main_action_button" ou "corner_action_button"
Botão para chamadas / número de telefone (guia "Visão geral") {"click", "call_place", "outbound"} "phone_number", "main_action_button" ou "corner_action_button"
Botão para o site / Site (guia "Visão geral") {"click", "place_website", "outbound"} "website", "main_action_button" ou "corner_action_button"
Link de atribuição {"click", "attribution", "outbound"} "review" ou "media"
Link de classificação {"click", "reviews", "outbound"} "rating" ou "review_summaries"
Link da declaração legal (links da caixa de diálogo ⓘ) {"click", "disclosure", "outbound"} null (não configurável)
Link do relatório {"click", "report", "outbound"} "media", "review" ou "generative_summary"
Link da avaliação {"click", "review", "outbound"} "review"
Link de mídia / foto {"click", "media", "outbound"} "media"
Lightbox de fotos aberto (no app) {"click", "media"} "media"
Guia "Visão geral" selecionada (no app) {"click", "overview_tab"} null
Guia "Avaliações" selecionada (no app) {"click", "reviews_tab"} "review"
Guia "Sobre" selecionada (no app) {"click", "about_tab"} "features"
Menu flutuante de avaliações (⋮) aberto (no app) {"click", "reviews_menu"} "review"
Menu flutuante do Lightbox (⋮) aberto (no app) {"click", "lightbox_menu"} "media"
Menu de resumo generativo (⋮) aberto (no app) {"click", "generative_summary_menu"} "generative_summary"
Menu de resumo de avaliações generativas (⋮) aberto (no app) {"click", "review_summary_menu"} "review"

Como novos eventos e tags podem ser adicionados ao longo do tempo, é possível anexar um gerenciador genérico durante o desenvolvimento para registrar todos os eventos transmitidos conforme você interage com um componente:

// 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))"
  )
}

Inscrever-se e processar eventos de análise

É possível se inscrever em eventos de análise de um componente do UI Kit usando o modificador onPlaceAnalyticsEvent. É possível anexar o modificador a uma visualização de contêiner ou diretamente a um componente do UI Kit.

O código a seguir mostra como se inscrever e processar eventos de análise em uma visualização de contêiner:

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
      ])
    }
  }
}

Se o app mostrar vários cards do mesmo tipo de widget (por exemplo, duas instâncias de PlaceDetailsCompactView), anexar .onPlaceAnalyticsEvent diretamente a cada visualização vai permitir que você saiba qual instância de card específica acionou o evento.

O snippet de código a seguir mostra como se inscrever e processar eventos de análise diretamente em um componente 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")
        }
      }
  }
}

Adicionar e processar callbacks de toque no cartão

Os callbacks de toque no cartão precisam ser configurados e processados separadamente para cada componente do kit de interface.

Use o modificador .onTap em um componente do Kit de Interface para processar toques no corpo do card. Quando o usuário toca no cartão, o .onTap transmite uma estrutura Place preenchida com três propriedades:

  • place.placeID (String?): o ID de lugar exclusivo para, por exemplo, abrir uma página completa do PlaceDetailsView ou selecionar um marcador.
  • place.location (CLLocationCoordinate2D): as coordenadas de latitude/longitude do lugar para, por exemplo, centralizar uma câmera de mapa ou colocar um marcador.
  • place.viewportInfo (RectangularCoordinateRegion?): os limites recomendados da janela de visualização do mapa (coordenadas northEast e southWest) para enquadrar o lugar em um mapa.

O código a seguir mostra como adicionar e processar um callback de toque no cartão para um 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)")
      }
    }
  }
}