Documentation de référence sur la classe GMSPlaceSearchNearbyRequest

Documentation de référence sur la classe GMSPlaceSearchNearbyRequest

Présentation

Objet de requête à utiliser avec GMSPlacesClient pour extraire les lieux à proximité.

Fonctions de membre public

(instancetype)- initWithLocationRestriction:placeProperties:
 Instancie un GMSPlaceSearchNearbyRequest avec une restriction d'emplacement et des propriétés de lieu à renvoyer.

Propriétés

ID< GMSPlaceLocationRestriction >locationRestriction
 L'initialisation par défaut n'est pas disponible.
NSArray&lt; GMSPlaceProperty > *.placeProperties
 Tableau de GMSPlaceProperty à inclure dans les résultats de lieu.
NSArray&lt; NSString * > *.includedTypes
 Tableau des types de lieux à inclure dans une recherche.
NSArray&lt; NSString * > *.excludedTypes
 Tableau des types de lieux à exclure d'une recherche.
NSArray&lt; NSString * > *.includedPrimaryTypes
 Tableau des principaux types de lieux à inclure dans une recherche.
NSArray&lt; NSString * > *.excludedPrimaryTypes
 Tableau des types de lieux principaux à exclure d'une recherche.
NSIntegermaxResultCount
 Nombre maximal de résultats GMSPlace à renvoyer.
NSString *regionCode
 Code CLDR (code pays/région) Unicode de l'emplacement d'origine de la requête.
GMSPlaceSearchNearbyRankPreferencerankPreference
 Le GMSPlaceSearchNearbyRankPreference permet de trier les résultats renvoyés par la requête.

Documentation sur les fonctions membres

- (instancetype) initWithLocationRestriction: (id < GMSPlaceLocationRestriction >) locationRestriction
placeProperties: (NSArray< GMSPlaceProperty > *) placeProperties

Instancie un GMSPlaceSearchNearbyRequest avec une restriction d'emplacement et des propriétés de lieu à renvoyer.

Paramètres :
locationRestrictionRégion dans laquelle effectuer la recherche, spécifiée sous la forme d'un cercle, définie par le point central et le rayon en mètres.
placePropertiesTableau de GMSPlaceProperty à inclure dans les résultats de lieu. Ce champ ne peut pas être vide. Une liste vide entraînera une erreur lors de la tentative d'envoi de la requête.

Documentation de la propriété

- (id<GMSPlaceLocationRestriction>) locationRestriction [read, write, copy]

L'initialisation par défaut n'est pas disponible.

Veuillez utiliser l'initialiseur indiqué. Région dans laquelle effectuer la recherche, spécifiée sous la forme d'un cercle, définie par le point central et le rayon en mètres. Le rayon doit être compris entre 0,0 et 50 000,0 inclus. Si vous contournez cette restriction, une erreur INVALID_ARGUMENT sera générée. La valeur locationRestriction doit être spécifiée avec GMSPlaceCircularLocationOption. L'utilisation de GMSPlaceRectangularLocationOption entraînera une erreur INVALID_REQUEST.

- (NSArray<GMSPlaceProperty>*) placeProperties [read, write, copy]

Tableau de GMSPlaceProperty à inclure dans les résultats de lieu.

Ce champ ne peut pas être vide. Une liste vide entraînera une erreur lors de la tentative d'envoi de la requête.

- (NSArray<NSString *>*) includedTypes [read, write, copy]

Tableau des types de lieux à inclure dans une recherche.

Vous pouvez spécifier jusqu'à 50 types. Si une requête est spécifiée avec plusieurs restrictions de type, seuls les lieux qui répondent à toutes les restrictions sont renvoyés. Si le tableau est vide, tous les lieux de tous types sont renvoyés. Consultez le tableau A pour obtenir la liste des types compatibles : https://developers.google.com/maps/documentation/places/web-service/place-types#table-a.

- (NSArray<NSString *>*) excludedTypes [read, write, copy]

Tableau des types de lieux à exclure d'une recherche.

Vous pouvez spécifier jusqu'à 50 types. Si une requête est spécifiée avec plusieurs restrictions de type, seuls les lieux qui répondent à toutes les restrictions sont renvoyés. Si des types conflictuels sont spécifiés (par exemple, des types apparaissant dans inclusTypes et excludedTypes), une erreur INVALID_REQUEST est renvoyée. Consultez le tableau A pour obtenir la liste des types compatibles : https://developers.google.com/maps/documentation/places/web-service/place-types#table-a.

- (NSArray<NSString *>*) includedPrimaryTypes [read, write, copy]

Tableau des principaux types de lieux à inclure dans une recherche.

Vous pouvez spécifier jusqu'à 50 types. Si une requête est spécifiée avec plusieurs restrictions de type, seuls les lieux qui répondent à toutes les restrictions sont renvoyés. Pour en savoir plus sur les types principaux, consultez la page https://developers.google.com/maps/documentation/places/web-service/nearby-search#includedtypesexcludedtypes,-includedprimarytypesexcludedprimarytypes.

- (NSArray<NSString *>*) excludedPrimaryTypes [read, write, copy]

Tableau des types de lieux principaux à exclure d'une recherche.

Si des types conflictuels sont spécifiés (par exemple, des types apparaissant dans inclusTypes et excludedTypes), une erreur INVALID_REQUEST est renvoyée. Vous pouvez spécifier jusqu'à 50 types. Si une requête est spécifiée avec plusieurs restrictions de type, seuls les lieux qui répondent à toutes les restrictions sont renvoyés. Pour en savoir plus sur les types principaux, consultez la page https://developers.google.com/maps/documentation/places/web-service/nearby-search#includedtypesexcludedtypes,-includedprimarytypesexcludedprimarytypes.

- (NSInteger) maxResultCount [read, write, assign]

Nombre maximal de résultats GMSPlace à renvoyer.

Doit être comprise entre 1 et 20 (valeur par défaut) Si vous dépassez cette restriction, une erreur sera renvoyée.

- (NSString*) regionCode [read, write, copy]

Code CLDR (code pays/région) Unicode de l'emplacement d'origine de la requête.

Pour connaître les codes des régions, consultez la page https://www.unicode.org/cldr/charts/44/supplemental/territory_language_information.html.

– (GMSPlaceSearchNearbyRankPreference) rankPreference [read, write, assign]

Le GMSPlaceSearchNearbyRankPreference permet de trier les résultats renvoyés par la requête.

La valeur par défaut est GMSPlaceSearchNearbyRankPopularity.