Documentation de référence sur la classe GMSPlacesClient

Documentation de référence sur la classe GMSPlacesClient

Présentation

Interface principale du SDK Places

Permet de rechercher des lieux et d'obtenir des informations les concernant. Cette classe est accessible via la méthode [GMSPlacesClient sharedClient].

Les méthodes GMSPlacesClient ne doivent être appelées qu'à partir du thread principal. L'appel de ces méthodes à partir d'un autre thread entraînera une exception ou un comportement non défini. Sauf indication contraire, tous les rappels seront appelés sur le thread principal.

Fonctions de membre public

(inutile)- lookUpPlaceID:callback:
 Obtenez des informations sur un lieu.
(inutile)- fetchAutocompleteSuggestionsFromRequest:callback:
 Trouvez les suggestions de saisie semi-automatique à partir d'une requête textuelle.
(inutile)- lookUpPhotosForPlaceID:callback:
 Récupère les métadonnées d'un maximum de 10 photos associées à un lieu.
(inutile)- loadPlacePhoto:callback:
 Charge l'image d'une photo spécifique dans sa taille maximale.
(inutile)- loadPlacePhoto:constrainedToSize:scale:callback:
 Charge l'image d'une photo spécifique, mise à l'échelle pour s'adapter aux dimensions maximales données.
(inutile)- currentPlaceWithCallback:
 Affiche une estimation de la localisation actuelle de l'appareil.
(inutile)- findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
 Recherchez des prédictions de saisie semi-automatique à partir d'une requête textuelle.
(inutile)- fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
 Extrayez les détails d'un lieu.
(inutile)- findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
 Déterminez la probabilité d'un lieu en utilisant la position actuelle de l'utilisateur.
(inutile)- isOpenWithRequest:callback:
 Récupère l'état d'ouverture d'un lieu.
(inutile)- isOpenWithPlaceID:callback:
 Récupère les détails d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus à l'heure actuelle.
(inutile)- isOpenWithPlaceID:date:callback:
 Récupère les détails d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus au NSDate spécifié.
(inutile)- isOpenWithPlace:callback:
 Récupère les détails d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus à l'heure actuelle.
(inutile)- isOpenWithPlace:date:callback:
 Récupère les détails d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus au NSDate spécifié.
(inutile)- searchByTextWithRequest:callback:
 Recherchez des lieux par texte et restrictions.
(inutile)- fetchPlaceWithRequest:callback:
 Obtenez un lieu à l'aide d'un objet de requête.
(inutile)- fetchPhotoWithRequest:callback:
 Demandez une photo à l'aide de la requête de récupération de photo.
(inutile)- searchNearbyWithRequest:callback:
 Recherchez des lieux à proximité d'un lieu et d'une restriction.

Fonctions de membre public statiques

(instancetype)+ sharedClient
 Fournit l'instance partagée de GMSPlacesClient pour le SDK Google Places pour iOS, en la créant si nécessaire.
(BOOL)+ provideAPIKey :
 Fournit votre clé API au SDK Google Places pour iOS.
(NSString *)+ openSourceLicenseInfo
 Renvoie les informations sur la licence du logiciel Open Source pour le SDK Google Places pour iOS.
(NSString *)+ SDKVersion
 Renvoie la version de cette version du SDK Google Places pour iOS.
(NSString *)+ SDKLongVersion
 Renvoie la version longue de cette version du SDK Google Places pour iOS.

Notez qu'il ne s'agit pas de fonctions membres.

typedef void(^GMSPlaceResultCallback )(GMSPlace *_Nullable result, NSError *_Nullable error)
 Type de rappel pour la réception de recherches de détails sur un lieu.
typedef void(^GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_NullableatmosphèreList, NSError *_Nullable error)
 Type de rappel pour la réception de listes de probabilité de lieu.
typedef void(^GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullablepossibles, NSError *_Nullable error)
 Type de rappel pour la réception d'un tableau de GMSPlaceLikelihood.
typedef void(^GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable results, NSError *_Nullable error)
 Type de rappel pour la réception des résultats de la saisie semi-automatique.
typedef void(^GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)
 Type de rappel pour la réception des résultats de photos de lieu.
typedef void(^GMSPlacePhotoImageResultCallback )(UIImage *_Nullable photo, NSError *_Nullable error)
 Type de rappel pour la réception d'objets UIImage d'un objet GMSPlacePhotoMetadata.
typedef void(^GMSPlaceOpenStatusCallback )(résultat GMSPlaceOpenStatus, NSError *_Nullable error)
 Type de rappel pour la réception de l'état des horaires d'ouverture du lieu.
typedef void(^GMSPlaceOpenStatusResponseCallback )(GMSPlaceIsOpenResponse *response, NSError *_Nullable error)
 Type de rappel pour la réception de la réponse d'état d'ouverture.
typedef void(^GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)
 Type de rappel pour la réception de résultats de recherche textuels.
typedef void(^GMSFetchPhotoResultCallback )(UIImage *_Nullable photoImage, NSError *_Nullable error)
 Type de rappel pour la réception d'une photo.
typedef void(^GMSAutocompleteSuggestionsCallback )(NSArray< GMSAutocompleteSuggestion * > *_Nullable results, NSError *_Nullable error)
 Type de rappel pour les résultats de la saisie semi-automatique
typedef void(^GMSPlaceSearchNearbyResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)
 Type de rappel pour la réception de résultats de recherche à proximité.

Documentation sur les fonctions membres

+ (instancetype) sharedClient

Fournit l'instance partagée de GMSPlacesClient pour le SDK Google Places pour iOS, en la créant si nécessaire.

Si votre application utilise souvent des méthodes de GMSPlacesClient, elle peut vouloir conserver cet objet directement, sinon votre connexion à Google risque d'être redémarrée régulièrement.

+ (BOOL) provideAPIKey : (NSString *) key

Fournit votre clé API au SDK Google Places pour iOS.

Cette clé est générée pour votre application via la console Google Cloud Platform et est associée à l'ID de bundle de votre application pour l'identifier. Celui-ci doit être appelé par votre application avant d'utiliser GMSPlacesClient (par exemple, dans application:didFinishLaunchingWithOptions:).

Renvoie :
OUI si la clé API a bien été fournie.
+ (NSString *) openSourceLicenseInfo

Renvoie les informations sur la licence du logiciel Open Source pour le SDK Google Places pour iOS.

Ces informations doivent être disponibles dans votre application.

+ (NSString *) SDKVersion

Renvoie la version de cette version du SDK Google Places pour iOS.

pour en savoir plus. Exemple : "1.0.0".

+ (NSString *) SDKLongVersion

Renvoie la version longue de cette version du SDK Google Places pour iOS.

pour en savoir plus. Par exemple, "1.0.0 (102.1)".

- (void) lookUpPlaceID: (NSString *) placeID
rappel: (GMSPlaceResultCallback) rappel

Obtenez des informations sur un lieu.

Cette méthode n'est pas bloquante.

Paramètres :
placeIDID de lieu à rechercher.
rappelRappel à invoquer avec le résultat de la recherche.
Remarque :
Cette fonctionnalité est obsolète. Cette méthode est remplacée par fetchPlaceWithRequest:callback: et sera supprimée dans une prochaine version.
- (void) retrieveAutocompleteSuggestionsFromRequest: (GMSAutocompleteRequest *) demande
rappel: (GMSAutocompleteSuggestionsCallback). rappel

Trouvez les suggestions de saisie semi-automatique à partir d'une requête textuelle.

Les résultats peuvent éventuellement être pondérés en faveur d'un lieu donné ou restreints à une zone spécifique. Cette méthode n'est pas bloquante.

Le rappel fourni est appelé avec un tableau de suggestions de saisie semi-automatique en cas de réussite et une erreur NSError en cas d'erreur.

Paramètres :
requestRequête GMSAutocompleteRequest de saisie semi-automatique.
rappelRappel à invoquer avec les suggestions.
- (void) lookUpPhotosForPlaceID: (NSString *) placeID
rappel: (GMSPlacePhotoMetadataResultCallback) rappel

Récupère les métadonnées d'un maximum de 10 photos associées à un lieu.

Les photos proviennent de différentes sources, y compris les propriétaires d'établissement et les photos fournies par les utilisateurs de Google+. Dans la plupart des cas, ces photos peuvent être utilisées sans attribution, ou contiendront l'attribution requise dans l'image. Cependant, vous devez utiliser la propriété attributions dans la réponse pour récupérer les attributions supplémentaires requises et les afficher dans votre application partout où vous affichez l'image. Un maximum de 10 photos est renvoyé.

Plusieurs appels de cette méthode renverront probablement les mêmes photos à chaque fois. Toutefois, cela n'est pas garanti, car les données sous-jacentes peuvent avoir changé.

Cette méthode effectue une recherche réseau.

Paramètres :
placeIDID de lieu pour lequel rechercher des photos.
rappelRappel à invoquer avec le résultat de la recherche.
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata
rappel: (GMSPlacePhotoImageResultCallback). rappel

Charge l'image d'une photo spécifique dans sa taille maximale.

Les données de l'image peuvent être mises en cache par le SDK. Si la photo demandée n'existe pas dans le cache, une recherche réseau est effectuée.

Paramètres :
photoMetadataLe GMSPlacePhotoMetadata pour lequel charger un UIImage.
rappelRappel à invoquer avec le UIImage chargé.
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata
constrainedToSize: (Taille du verre de protection) maxSize
échelle: (CGFloat) Échelle
rappel: (GMSPlacePhotoImageResultCallback). rappel

Charge l'image d'une photo spécifique, mise à l'échelle pour s'adapter aux dimensions maximales données.

L'image est mise à l'échelle pour s'adapter aux dimensions données tout en conservant les proportions de l'image d'origine. Ce scaling est effectué côté serveur.

Si le paramètre d'échelle n'est pas 1.0, la valeur maxSize sera multipliée par cette valeur, et la valeur UIImage renvoyée sera définie sur l'échelle spécifiée. Ce paramètre doit être défini sur l'échelle de l'écran si vous chargez des images à afficher à l'écran.

Les données de l'image peuvent être mises en cache par le SDK. Si la photo demandée n'existe pas dans le cache, une recherche réseau est effectuée.

Remarque :
Une fois le facteur d'échelle appliqué, les dimensions spécifiées dans "maxSize" sont arrondies à l'entier le plus proche avant utilisation. Si une image plus grande que la taille maximale disponible est demandée, une image plus petite peut être renvoyée.
<ph type="x-smartling-placeholder">
</ph>
Paramètres :
photoMetadataLe GMSPlacePhotoMetadata pour lequel charger un UIImage.
maxSizeTaille maximale de l'image.
Google.Échelle à laquelle l'image doit être chargée.
rappelRappel à invoquer avec le UIImage chargé.

Affiche une estimation de la localisation actuelle de l'appareil.

Génère une liste de probabilités de lieux en fonction de la dernière position estimée de l'appareil. Le rappel fourni est invoqué avec cette liste de probabilité en cas de réussite et une erreur NSError en cas d'erreur.

Remarque :
Pour utiliser cette méthode, votre application doit être autorisée à accéder à la position actuelle de l'appareil. Avant d'appeler cette méthode, veillez à demander l'accès à la position géographique de l'utilisateur à l'aide de [CLLocationManager requestWhenInUseAuthorization] ou de [CLLocationManager requestToujoursAuthorization]. Si vous appelez cette méthode et que l'état d'autorisation de votre application est incorrect, le rappel sera appelé avec une erreur.
<ph type="x-smartling-placeholder">
</ph>
Paramètres :
rappelRappel à invoquer avec la liste de probabilité de lieu.
- (void) findAutocompletePredictionsFromQuery: (NSString *) query
filtre : (GMSAutocompleteFilter* pouvant avoir une valeur nulle) filtre
sessionToken: (GMSAutocompleteSessionToken* pouvant avoir une valeur nulle) sessionToken
rappel: (GMSAutocompletePredictionsCallback). rappel

Recherchez des prédictions de saisie semi-automatique à partir d'une requête textuelle.

Les résultats peuvent éventuellement être pondérés en faveur d'un lieu donné ou restreints à une zone spécifique. Cette méthode n'est pas bloquante.

Le rappel fourni est appelé avec un tableau de prédictions de saisie semi-automatique en cas de réussite et une erreur NSError en cas d'erreur.

Paramètres :
requêteTexte partiel à utiliser pour la saisie semi-automatique.
filtreFiltre à appliquer aux résultats. Ce paramètre peut être nul.
sessionTokenLe GMSAutocompleteSessionToken pour associer la requête à une session de facturation.
rappelRappel à invoquer avec les prédictions.
- (void) retrievePlaceFromPlaceID: (NSString *) placeID
placeFields: (GMSPlaceField). placeFields
sessionToken: (GMSAutocompleteSessionToken* pouvant avoir une valeur nulle) sessionToken
rappel: (GMSPlaceResultCallback) rappel

Extrayez les détails d'un lieu.

Cette méthode n'est pas bloquante.

Paramètres :
placeIDID de lieu à rechercher.
placeFieldsChamps de lieu individuels demandés pour les objets de lieu de la liste.
sessionTokenLe GMSAutocompleteSessionToken pour associer la requête à une session de facturation.
rappelRappel à invoquer avec le résultat de la recherche.
Remarque :
Cette fonctionnalité est obsolète. Cette méthode est remplacée par fetchPlaceWithRequest:callback: callback: et sera supprimée dans une prochaine version.
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: (GMSPlaceField). placeFields
rappel: (GMSPlaceLikelihoodsCallback) rappel

Déterminez la probabilité d'un lieu en utilisant la position actuelle de l'utilisateur.

Cette méthode n'est pas bloquante.

Le rappel fourni sera invoqué avec un tableau de lieux avec des scores de probabilité en cas de réussite et une erreur NSError en cas d'erreur.

Paramètres :
placeFieldsChamps de lieu individuels demandés pour les objets de lieu de la liste.
rappelRappel à invoquer avec des probabilités de lieu.
- (void) isOpenWithRequest: (GMSPlaceIsOpenRequest *) isOpenRequest
rappel: (GMSPlaceOpenStatusResponseCallback) rappel

Récupère l'état d'ouverture d'un lieu, y compris toutes les propriétés nécessaires pour déterminer GMSPlaceOpenStatus à la date NSDate spécifiée. Cette méthode n'est pas bloquante.

Paramètres :
isOpenRequestRequête permettant de déterminer l'état d'ouverture d'un lieu donné.
rappelRappel à invoquer avec la réponse d'état "ouvert".
- (void) isOpenWithPlaceID: (NSString *) placeID
rappel: (GMSPlaceOpenStatusCallback). rappel

Récupère l'état d'ouverture d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus à l'heure actuelle.

Cette méthode n'est pas bloquante.

Paramètres :
placeIDID de lieu à rechercher.
rappelRappel à invoquer avec le résultat du lieu.
- (void) isOpenWithPlaceID: (NSString *) placeID
Date : (NSDate *) date
rappel: (GMSPlaceOpenStatusCallback). rappel

Récupère l'état d'ouverture d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus au niveau NSDate spécifié.

Cette méthode n'est pas bloquante.

Paramètres :
placeIDID de lieu à rechercher.
dateLe NSDate pour lequel déterminer l'état d'ouverture.
rappelRappel à invoquer avec le résultat du lieu.
- (void) isOpenWithPlace: (GMSPlace *) lieu
rappel: (GMSPlaceOpenStatusCallback). rappel

Récupère l'état d'ouverture d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus à l'heure actuelle.

Ne demande des champs supplémentaires que si GMSPlace ne contient pas tous les champs nécessaires. Sinon, GMSPlaceOpenStatus sera immédiatement renvoyé dans le rappel. Cette méthode n'est pas bloquante.

Paramètres :
lieuLe GMSPlace à rechercher.
rappelRappel à invoquer avec le résultat du lieu.
- (void) isOpenWithPlace: (GMSPlace *) lieu
Date : (NSDate *) date
rappel: (GMSPlaceOpenStatusCallback). rappel

Récupère les détails d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus au NSDate spécifié.

Ne demande des champs supplémentaires que si GMSPlace ne contient pas tous les champs nécessaires. Sinon, GMSPlaceOpenStatus\ will be returned in the callback immediately. This method is non-blocking.

Parameters:
placeThe GMSPlace to lookup.
dateThe NSDate to determine open status for.
callbackThe callback to invoke with the place result.

- (void) searchByTextWithRequest: (GMSPlaceSearchByTextRequest *) textSearchRequest
rappel: (GMSPlaceSearchByTextResultCallback) rappel

Recherchez des lieux par texte et restrictions.

Cette méthode n'est pas bloquante.

Paramètres :
textSearchRequestGMSPlaceSearchByTextRequest : requête de texte à utiliser pour la requête.
rappelRappel à invoquer avec le résultat de la recherche.
- (void) retrievePlaceWithRequest: (GMSFetchPlaceRequest *) fetchPlaceRequest
rappel: (GMSPlaceResultCallback) rappel

Obtenez un lieu à l'aide d'un objet de requête.

Cette méthode n'est pas bloquante.

Paramètres :
fetchPlaceRequestGMSFetchPlaceRequest : requête de récupération de lieu à utiliser pour la requête.
rappelRappel à invoquer avec le résultat du lieu.
- (void) retrievePhotoWithRequest: (GMSFetchPhotoRequest *) fetchPhotoRequest
rappel: (GMSFetchPhotoResultCallback) rappel

Demandez une photo à l'aide de la requête de récupération de photo.

Cette méthode n'est pas bloquante.

Paramètres :
fetchPhotoRequestGMSFetchPhotoRequest Requête de photo à utiliser.
rappelRappel à invoquer avec le résultat NSURL.
- (void) searchNearbyWithRequest: (GMSPlaceSearchNearbyRequest *) searchNearbyRequest
rappel: (GMSPlaceSearchNearbyResultCallback) rappel

Recherchez des lieux à proximité d'un lieu et d'une restriction.

Cette méthode n'est pas bloquante.

Paramètres :
searchNearbyRequestGMSPlaceSearchNearbyRequest : requête de recherche à proximité à utiliser pour la requête.
rappelRappel à invoquer avec le résultat de la recherche.

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

Type de rappel pour la réception de recherches de détails sur un lieu.

Si une erreur s'est produite, result sera nul et error contiendra des informations sur l'erreur.

Paramètres :
résultatLe GMSPlace renvoyé.
erreurL'erreur qui s'est produite, le cas échéant.
- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_NullableTrueList, NSError *_Nullable error)) [related]

Type de rappel pour la réception de listes de probabilité de lieu.

Si une erreur s'est produite, likelihoodList sera nul et error contiendra des informations sur l'erreur.

Paramètres :
likelihoodListListe des probabilités de lieu.
erreurL'erreur qui s'est produite, le cas échéant.
- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullablepossibles, NSError *_Nullable error)) [related]

Type de rappel pour la réception d'un tableau de GMSPlaceLikelihood.

Si une erreur s'est produite, le tableau sera nul et error contiendra des informations sur l'erreur.

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

Type de rappel pour la réception des résultats de la saisie semi-automatique.

results est un tableau de GMSAutocompletePredictions représentant les achèvements candidats de la requête.

Paramètres :
résultatsTableau de valeurs GMSAutocompletePrediction.
erreurL'erreur qui s'est produite, le cas échéant.
- (typedef void(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)) [related]

Type de rappel pour la réception des résultats de photos de lieu.

Si une erreur s'est produite, photos sera nul et error contiendra des informations sur l'erreur.

Paramètres :
photosLe résultat contient des objets GMSPlacePhotoMetadata.
erreurL'erreur qui s'est produite, le cas échéant.
- (typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable photo, NSError *_Nullable error)) [related]

Type de rappel pour la réception d'objets UIImage d'un objet GMSPlacePhotoMetadata.

Si une erreur s'est produite, photo sera nul et error contiendra des informations sur l'erreur.

Paramètres :
photoLe UIImage qui a été chargé.
erreurL'erreur qui s'est produite, le cas échéant.
- (typedef void(^ GMSPlaceOpenStatusCallback)(résultat de GMSPlaceOpenStatus, NSError *_Nullable error)) [related]

Type de rappel pour la réception de l'état des horaires d'ouverture du lieu.

Si une erreur s'est produite, result sera GMSPlaceOpenStatusUnknown et error contiendra des informations sur l'erreur.

Paramètres :
résultatLe GMSPlaceOpenStatus renvoyé.
erreurL'erreur qui s'est produite, le cas échéant.
- (typedef void(^ GMSPlaceOpenStatusResponseCallback)(GMSPlaceIsOpenResponse *response, NSError *_Nullable error)) [related]

Type de rappel pour la réception de la réponse d'état d'ouverture.

Si une erreur s'est produite, la réponse aura l'état GMSPlaceOpenStatusUnknown et l'erreur contiendra des informations sur l'erreur.

Paramètres :
réponseLe GMSPlaceIsOpenResponse renvoyé.
erreurL'erreur qui s'est produite, le cas échéant.
- (typedef void(^ GMSPlaceSearchByTextResultCallback)(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)) [related]

Type de rappel pour la réception de résultats de recherche textuels.

results est un tableau de GMSPlace représentant les résultats individuels correspondant à la requête.

Paramètres :
résultatsTableau de valeurs GMSPlace.
erreurL'erreur qui s'est produite, le cas échéant.
- (typedef void(^ GMSFetchPhotoResultCallback)(UIImage *_Nullable photoImage, NSError *_Nullable error)) [related]

Type de rappel pour la réception d'une photo.

photoImage est un UIImage représentant la photo obtenue correspondant à la requête spécifiée. Si une erreur s'est produite, photoImage sera nul et error contiendra des informations sur l'erreur.

Paramètres :
photoImageUn résultat UIImage.
- (typedef void(^ GMSAutocompleteSuggestionsCallback)(NSArray< GMSAutocompleteSuggestion * > *_Nullable results, NSError *_Nullable error)) [related]

Type de rappel pour les résultats de la saisie semi-automatique

Paramètres :
résultatsTableau de GMSAutocompleteSuggestion.
erreurL'erreur qui s'est produite, le cas échéant.
- (typedef void(^ GMSPlaceSearchNearbyResultCallback)(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)) [related]

Type de rappel pour la réception de résultats de recherche à proximité.

Paramètres :
lieuxUn tableau de GMSPlace
erreurL'erreur qui s'est produite, le cas échéant.