Referencia de la clase GMSPlacesClient


Descripción general

Interfaz principal del SDK de Places.

Se usa para buscar y obtener detalles sobre lugares. Se debe acceder a esta clase a través del método [GMSPlacesClient sharedClient].

Los métodos GMSPlacesClient solo deben llamarse desde el subproceso principal. Si llamas a estos métodos desde otro subproceso, se generará una excepción o un comportamiento indefinido. A menos que se especifique lo contrario, se invocarán todas las devoluciones de llamada en el subproceso principal.

Funciones públicas de miembro

(void) - lookUpPlaceID:callback:
 Obtén detalles de un lugar.
(void) - lookUpPhotosForPlaceID:callback:
 Obtiene los metadatos de hasta 10 fotos asociadas con un lugar.
(void) - loadPlacePhoto:callback:
 Carga la imagen de una foto específica en su tamaño máximo.
(void) - loadPlacePhoto:constrainedToSize:scale:callback:
 Carga la imagen de una foto específica, ajustada a escala para adaptarse a las dimensiones máximas determinadas.
(void) - currentPlaceWithCallback:
 Muestra una estimación del sitio donde se sabe que el dispositivo se encuentra actualmente.
(void) - findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
 Busca predicciones de Autocomplete a partir de una consulta de texto.
(void) - fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
 Obtener detalles para un lugar.
(void) - findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
 Encuentra las probabilidades de lugar usando la ubicación actual del usuario.
(void) - isOpenWithPlaceID:callback:
 Obtiene detalles de un lugar que incluye todos los campos necesarios para determinar GMSPlaceOpenStatus en la hora actual.
(void) - isOpenWithPlaceID:date:callback:
 Obtiene detalles de un lugar que incluyen todos los campos necesarios para determinar GMSPlaceOpenStatus en el NSDate especificado.
(void) - isOpenWithPlace:callback:
 Obtiene detalles de un lugar que incluye todos los campos necesarios para determinar GMSPlaceOpenStatus en la hora actual.
(void) - isOpenWithPlace:date:callback:
 Obtiene detalles de un lugar que incluyen todos los campos necesarios para determinar GMSPlaceOpenStatus en el NSDate especificado.
(void) - searchByTextWithRequest:callback:
 Busca lugares por texto y restricciones.

Funciones de miembro públicas estáticas

(tipo de instancia)+ sharedClient
 Proporciona la instancia compartida de GMSPlacesClient para el SDK de Google Places para iOS y la crea si es necesario.
(BOOL) + providedAPIKey:
 Proporciona tu clave de API al SDK de Google Places para iOS.
(NSString *)Más openSourceLicenseInfo
 Muestra la información de la licencia de software de código abierto del SDK de Google Places para iOS.
(NSString *)+ SDKVersion
 Muestra la versión para esta versión del SDK de Google Places para iOS.
(NSString *)+ SDKLongVersion
 Muestra la versión larga de esta versión del SDK de Google Places para iOS.

(ten en cuenta que estas no son funciones de los miembros).

typedef void(^ GMSPlaceResultCallback )(GMSPlace *_Nullable result, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir búsquedas de detalles de lugares.
typedef void(^ GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_Nullable likelihoodList, error NSError *_Nullable)
 Tipo de devolución de llamada para recibir listas de probabilidades de lugares.
typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable probablemente, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir arrays de GMSPlaceLikelihood.
typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable results, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir resultados de autocompletado.
typedef void(^ GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir resultados de fotos de lugares.
typedef void(^ GMSPlacePhotoImageResultCallback )(UIImage *_Nullable photo, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir objetos UIImage de un objeto GMSPlacePhotoMetadata.
typedef void(^ GMSPlaceOpenStatusCallback )(resultado GMSPlaceOpenStatus, error NSError *_Nullable)
 Tipo de devolución de llamada para recibir el estado del horario de atención de Place.
typedef void(^ GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir resultados de búsqueda por texto.

Documentación sobre la función del miembro

+ (tipo de instancia) sharedClient

Proporciona la instancia compartida de GMSPlacesClient para el SDK de Google Places para iOS y la crea si es necesario.

Si tu aplicación suele usar métodos de GMSPlacesClient, es posible que quieras retener este objeto directamente, ya que, de lo contrario, tu conexión con Google podría reiniciarse periódicamente.

+ (BOOL) provideAPIKey: (NSString *) Clave

Proporciona tu clave de API al SDK de Google Places para iOS.

Esta clave se genera para tu aplicación a través de Google Cloud Platform Console y se vincula con el ID del paquete de tu aplicación a fin de identificarla. La aplicación debe llamar a este método antes de usar GMSPlacesClient (p.ej., en application:didFinishLaunchingWithOptions:).

Devuelve:
SÍ si la APIKey se proporcionó correctamente.
+ (NSString *) openSourceLicenseInfo

Muestra la información de la licencia de software de código abierto del SDK de Google Places para iOS.

Esta información debe estar disponible en tu solicitud.

+ (NSString *) SDKVersion

Muestra la versión para esta versión del SDK de Google Places para iOS.

. Por ejemplo, “1.0.0”.

+ (NSString *) SDKLongVersion

Muestra la versión larga de esta versión del SDK de Google Places para iOS.

. Por ejemplo, "1.0.0 (102.1)".

- (void) lookUpPlaceID: (NSString *) placeID
devolución de llamada: (GMSPlaceResultCallback). devolución de llamada

Obtén detalles de un lugar.

Este método no genera bloqueos.

Parámetros:
placeIDEl ID de lugar que se debe buscar.
callbackEs la devolución de llamada que se invocará con el resultado de la búsqueda.
- (void) lookUpPhotosForPlaceID: (NSString *) placeID
devolución de llamada: (GMSPlacePhotoMetadataResultCallback). devolución de llamada

Obtiene los metadatos de hasta 10 fotos asociadas con un lugar.

Las fotos se obtienen de una variedad de ubicaciones, como propietarios de empresas y fotos aportadas por usuarios de Google+. En la mayoría de los casos, estas fotos se pueden usar sin atribución, o tendrán la atribución requerida incluida como parte de la imagen. Sin embargo, debes usar la propiedad attributions en la respuesta para recuperar atribuciones adicionales requeridas y mostrarlas en tu aplicación donde sea que muestres la imagen. Se devuelve un máximo de 10 fotos.

Es probable que las llamadas múltiples de este método muestren las mismas fotos cada vez. Sin embargo, esto no está garantizado porque los datos subyacentes pueden haber cambiado.

Este método realiza una búsqueda de red.

Parámetros:
placeIDEl ID de lugar desde el que se buscarán fotos.
callbackEs la devolución de llamada que se invocará con el resultado de la búsqueda.
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *). photoMetadata
devolución de llamada: (GMSPlacePhotoImageResultCallback). devolución de llamada

Carga la imagen de una foto específica en su tamaño máximo.

El SDK puede almacenar en caché los datos de imágenes. Si la foto solicitada no existe en la caché, se realizará una búsqueda de red.

Parámetros:
photoMetadataEl GMSPlacePhotoMetadata para el que se carga un UIImage.
callbackLa devolución de llamada que se invocará con el UIImage cargado
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *). photoMetadata
restrictedToSize: (CGSize) maxSize
escala: (CGFloat) escalar
devolución de llamada: (GMSPlacePhotoImageResultCallback). devolución de llamada

Carga la imagen de una foto específica, ajustada a escala para adaptarse a las dimensiones máximas determinadas.

La imagen se ajustará para adaptarse a las dimensiones indicadas y, al mismo tiempo, se mantendrá la relación de aspecto de la imagen original. Este escalamiento se realiza en el servidor.

Si el parámetro de escala no es 1.0, se multiplica maxSize por este valor y el UIImage que se muestra se establecerá para tener la escala especificada. Este parámetro debe establecerse en la escala de pantalla si cargas imágenes para mostrar en la pantalla.

El SDK puede almacenar en caché los datos de imágenes. Si la foto solicitada no existe en la caché, se realizará una búsqueda de red.

Nota:
Después de aplicar el factor de escala, las dimensiones en maxSize se redondearán al número entero más cercano antes de usarlas. Si se solicita una imagen que supera el tamaño máximo disponible, es posible que se muestre una imagen más pequeña.
Parámetros:
photoMetadataEl GMSPlacePhotoMetadata para el que se carga un UIImage.
maxSizeEl tamaño máximo de la imagen.
de Google.Es la escala en la que se cargará la imagen.
callbackLa devolución de llamada que se invocará con el UIImage cargado

Muestra una estimación del sitio donde se sabe que el dispositivo se encuentra actualmente.

Genera una lista de probabilidades de lugar basada en la última ubicación estimada del dispositivo. La devolución de llamada proporcionada se invocará con esta lista de probabilidades si la operación es exitosa y con un NSError cuando se produce un error.

Nota:
Este método requiere que la app tenga permiso para acceder a la ubicación actual del dispositivo. Antes de llamar a este método, asegúrate de solicitar acceso a la ubicación del usuario con [CLLocationManager requestWhenInUseAuthorization] o [CLLocationManager requestAlwaysAuthorization]. Si llamas a este método y tu app no tiene el estado de autorización correcto, se llamará a la devolución de llamada con un error.
Parámetros:
callbackLa devolución de llamada que se invocará con la lista de probabilidades de lugar.
- (void) findAutocompletePredictionsFromQuery: (NSString *) query
filtro: (nulable GMSAutocompleteFilter *) filtro
sessionToken: (GMSAutocompleteSessionToken * anulable) sessionToken
devolución de llamada: (GMSAutocompletePredictionsCallback). devolución de llamada

Busca predicciones de Autocomplete a partir de una consulta de texto.

Los resultados pueden personalizarse opcionalmente para una ubicación determinada o restringirse a un área. Este método no genera bloqueos.

La devolución de llamada proporcionada se invocará con un arreglo de predicciones de autocompletado si la operación es exitosa y con un NSError cuando haya un error.

Parámetros:
búsquedaTexto parcial para autocompletar
filterEs el filtro que se aplica a los resultados. Este parámetro puede ser "nil".
sessionTokenEl GMSAutocompleteSessionToken para asociar la solicitud a una sesión de facturación.
callbackLa devolución de llamada que se invocará con las predicciones.
- (void) fetchPlaceFromPlaceID: (NSString *) placeID
PlaceFields: (GMSPlaceField). placeFields
sessionToken: (GMSAutocompleteSessionToken * anulable) sessionToken
devolución de llamada: (GMSPlaceResultCallback). devolución de llamada

Obtener detalles para un lugar.

Este método no genera bloqueos.

Parámetros:
placeIDEl ID de lugar que se debe buscar.
placeFieldsSon los campos de lugar individuales solicitados para los objetos de lugar de la lista.
sessionTokenEl GMSAutocompleteSessionToken para asociar la solicitud a una sesión de facturación.
callbackEs la devolución de llamada que se invocará con el resultado de la búsqueda.
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: (GMSPlaceField). placeFields
devolución de llamada: (GMSPlaceLikelihoodsCallback). devolución de llamada

Encuentra las probabilidades de lugar usando la ubicación actual del usuario.

Este método no genera bloqueos.

La devolución de llamada proporcionada se invocará con un array de lugares con puntuaciones de probabilidad cuando se tiene éxito y un NSError cuando se produce un error.

Parámetros:
placeFieldsSon los campos de lugar individuales solicitados para los objetos de lugar de la lista.
callbackLa devolución de llamada que se debe invocar con las probabilidades de lugar.
- (void) isOpenWithPlaceID: (NSString *) placeID
devolución de llamada: (GMSPlaceOpenStatusCallback). devolución de llamada

Obtiene detalles de un lugar que incluye todos los campos necesarios para determinar GMSPlaceOpenStatus en la hora actual.

Este método no genera bloqueos.

Parámetros:
placeIDEl ID de lugar que se debe buscar.
callbackEs la devolución de llamada que se debe invocar con el resultado de lugar.
- (void) isOpenWithPlaceID: (NSString *) placeID
Fecha: (NSDate *) date
devolución de llamada: (GMSPlaceOpenStatusCallback). devolución de llamada

Obtiene detalles de un lugar que incluyen todos los campos necesarios para determinar GMSPlaceOpenStatus en el NSDate especificado.

Este método no genera bloqueos.

Parámetros:
placeIDEl ID de lugar que se debe buscar.
dateEl NSDate para el que se determina el estado abierto.
callbackEs la devolución de llamada que se debe invocar con el resultado de lugar.
- (void) isOpenWithPlace: (GMSPlace *) lugar
devolución de llamada: (GMSPlaceOpenStatusCallback). devolución de llamada

Obtiene detalles de un lugar que incluye todos los campos necesarios para determinar GMSPlaceOpenStatus en la hora actual.

Solo solicita campos adicionales si GMSPlace no tiene todos los campos necesarios; de lo contrario, se mostrará de inmediato GMSPlaceOpenStatus en la devolución de llamada. Este método no genera bloqueos.

Parámetros:
lugarEl GMSPlace que se debe buscar.
callbackEs la devolución de llamada que se debe invocar con el resultado de lugar.
- (void) isOpenWithPlace: (GMSPlace *) lugar
Fecha: (NSDate *) date
devolución de llamada: (GMSPlaceOpenStatusCallback). devolución de llamada

Obtiene detalles de un lugar que incluyen todos los campos necesarios para determinar GMSPlaceOpenStatus en el NSDate especificado.

Solo solicita campos adicionales si GMSPlace no tiene todos los campos necesarios; de lo contrario, se mostrará de inmediato GMSPlaceOpenStatus en la devolución de llamada. Este método no genera bloqueos.

Parámetros:
lugarEl GMSPlace que se debe buscar.
dateEl NSDate para el que se determina el estado abierto.
callbackEs la devolución de llamada que se debe invocar con el resultado de lugar.
- (void) searchByTextWithRequest: (GMSPlaceSearchByTextRequest *). textSearchRequest
devolución de llamada: (GMSPlaceSearchByTextResultCallback). devolución de llamada

Busca lugares por texto y restricciones.

Este método no genera bloqueos.

Parámetros:
textSearchRequestGMSPlaceSearchByTextRequest: La solicitud de texto que se usará para la consulta.
callbackEs la devolución de llamada que se invocará con el resultado de la búsqueda.

- (typedef void(^ GMSPlaceResultCallback)(GMSPlace *_Nullable result, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir búsquedas de detalles de lugares.

Si se produjo un error, result será nulo y error contendrá información sobre el error.

Parámetros:
resultadoEl GMSPlace que se mostró.
errorEl error que se produjo, si existiera.
- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_Nullable probablemente, NSError *_error nulo)) [related]

Tipo de devolución de llamada para recibir listas de probabilidades de lugares.

Si se produjo un error, likelihoodList será nulo y error contendrá información sobre el error.

Parámetros:
likelihoodListLa lista de probabilidades de lugar.
errorEl error que se produjo, si existiera.
- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullable probablemente, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir arrays de GMSPlaceLikelihood.

Si se produjo un error, el array será nulo y error contendrá información sobre el error.

- (typedef void(^ GMSAutocompletePredictionsCallback)(NSArray< GMSAutocompletePrediction * > *_Nullable results, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir resultados de autocompletado.

results es un array de GMSAutocompletePredictions que representa la finalización de los candidatos para la consulta.

Parámetros:
resultadosUn array de GMSAutocompletePrediction
errorEl error que se produjo, si existiera.
- (typedef void(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir resultados de fotos de lugares.

Si se produjo un error, photos será nulo y error contendrá información sobre el error.

Parámetros:
fotosEl resultado que contiene objetos GMSPlacePhotoMetadata.
errorEl error que se produjo, si existiera.
- (typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable photo, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir objetos UIImage de un objeto GMSPlacePhotoMetadata.

Si se produjo un error, photo será nulo y error contendrá información sobre el error.

Parámetros:
fotoEl UIImage que se cargó.
errorEl error que se produjo, si existiera.
- (typedef void(^ GMSPlaceOpenStatusCallback)(resultado GMSPlaceOpenStatus, NSError *_error nulo)) [related]

Tipo de devolución de llamada para recibir el estado del horario de atención de Place.

Si se produjo un error, result será GMSPlaceOpenStatusUnknown y error contendrá información sobre el error.

Parámetros:
resultadoEl GMSPlaceOpenStatus que se mostró.
errorEl error que se produjo, si existiera.
- (typedef void(^ GMSPlaceSearchByTextResultCallback)(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir resultados de búsqueda por texto.

results es un array de GMSPlace que representa resultados individuales que coinciden con la consulta.

Parámetros:
resultadosUn array de GMSPlace
errorEl error que se produjo, si existiera.