GooglePlaces Framework Reference Stay organized with collections Save and categorize content based on your preferences.
AI-generated Key Takeaways
This document lists globally available type definitions used in the Google Maps Places SDK for iOS.
These types define properties for places, callbacks for various place-related operations, and structures for handling place data.
They are used for tasks like requesting place details, fetching photos, handling autocomplete suggestions, and more.
Developers can leverage these types to interact with the Places SDK and access place information in their applications.
Each type definition includes its declaration in both Swift and Objective-C, along with descriptions of its parameters and purpose.
Type-Definitions
The following type definitions are available globally.
The properties represent individual information that can be requested for
GMSPlaceobjects. If no request properties are set, theGMSPlaceobject will be empty with no useful information.Note:
GMSPlacePropertyPhoneNumber,GMSPlacePropertyWebsite, andGMSPlacePropertyAddressComponentsare not supported forGMSPlaceLikelihoodListplace objects. Refer tohttps://developers.google.com/places/ios-sdk/place-data-fields for more details.Declaration
Swift
structGMSPlaceProperty:_ObjectiveCBridgeable,Hashable,Equatable,_SwiftNewtypeWrapper,RawRepresentable,@uncheckedSendableObjective-C
typedefNSString*constGMSPlacePropertyCompletion type for receiving App Check tokens. If an error occurred,
tokenwill be nil anderrorwill contain information about the error.Declaration
Swift
typealiasGMSAppCheckTokenCompletion=(String?,(anyError)?)->VoidObjective-C
typedefvoid(^GMSAppCheckTokenCompletion)(NSString*_Nullable,NSError*_Nullable)Parameters
tokenThe
NSStringthat was returned.errorThe error that occurred, if any.
Callback type for receiving place details lookups. If an error occurred,
resultwill be nil anderrorwill contain information about the error.Declaration
Swift
typealiasGMSPlaceResultCallback=(GMSPlace?,(anyError)?)->VoidObjective-C
typedefvoid(^GMSPlaceResultCallback)(GMSPlace*_Nullable,NSError*_Nullable)Parameters
resultThe
GMSPlacethat was returned.errorThe error that occurred, if any.
Deprecated
This method is replaced by
GMSPlaceSearchNearbyResultCallbackand will be removed in a future release.Callback type for receiving place likelihood lists. If an error occurred,
likelihoodListwill be nil anderrorwill contain information about the error.Declaration
Swift
typealiasGMSPlaceLikelihoodListCallback=(GMSPlaceLikelihoodList?,(anyError)?)->VoidObjective-C
typedefvoid(^GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList*_Nullable,NSError*_Nullable)Parameters
likelihoodListThe list of place likelihoods.
errorThe error that occurred, if any.
Deprecated
This method is replaced by
GMSPlaceSearchNearbyResultCallbackand will be removed in a future release.Callback type for receiving array of
GMSPlaceLikelihoods. If an error occurred, the array will be nil anderrorwill contain information about the error.Declaration
Swift
typealiasGMSPlaceLikelihoodsCallback=([GMSPlaceLikelihood]?,(anyError)?)->VoidObjective-C
typedefvoid(^GMSPlaceLikelihoodsCallback)(NSArray<GMSPlaceLikelihood*>*_Nullable,NSError*_Nullable)Deprecated
This method is replaced by
GMSAutocompleteSuggestionsCallbackand will be removed in a future release.Callback type for receiving autocompletion results.
resultsis an array ofGMSAutocompletePredictionsrepresenting candidate completions of the query.Declaration
Swift
typealiasGMSAutocompletePredictionsCallback=([GMSAutocompletePrediction]?,(anyError)?)->VoidObjective-C
typedefvoid(^GMSAutocompletePredictionsCallback)(NSArray<GMSAutocompletePrediction*>*_Nullable,NSError*_Nullable)Parameters
resultsAn array of
GMSAutocompletePredictions.errorThe error that occurred, if any.
Deprecated
This method is replaced by
GMSPlaceResultCallbackand will be removed in a future release.Callback type for receiving place photos results. If an error occurred,
photoswill be nil anderrorwill contain information about the error.Declaration
Swift
typealiasGMSPlacePhotoMetadataResultCallback=(GMSPlacePhotoMetadataList?,(anyError)?)->VoidObjective-C
typedefvoid(^GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList*_Nullable,NSError*_Nullable)Parameters
photosThe result containing
GMSPlacePhotoMetadataobjects.errorThe error that occurred, if any.
Deprecated
This method is replaced by
GMSFetchPhotoResultCallbackand will be removed in a future release.Callback type for receiving
UIImageobjects from aGMSPlacePhotoMetadataobject. If an error occurred,photowill be nil anderrorwill contain information about the error.Declaration
Swift
typealiasGMSPlacePhotoImageResultCallback=(UIImage?,(anyError)?)->VoidObjective-C
typedefvoid(^GMSPlacePhotoImageResultCallback)(UIImage*_Nullable,NSError*_Nullable)Parameters
photoThe
UIImagewhich was loaded.errorThe error that occurred, if any.
Deprecated
This method is replaced by
GMSPlaceOpenStatusResponseCallbackand will be removed in a future release.Callback type for receiving the opening hours status for the Place. If an error occurred,
resultwill beGMSPlaceOpenStatusUnknownanderrorwill contain information about the error.Declaration
Swift
typealiasGMSPlaceOpenStatusCallback=(GMSPlaceOpenStatus,(anyError)?)->VoidObjective-C
typedefvoid(^GMSPlaceOpenStatusCallback)(GMSPlaceOpenStatus,NSError*_Nullable)Parameters
resultThe
GMSPlaceOpenStatusthat was returned.errorThe error that occurred, if any.
Callback type for receiving the open status response. If an error occurred, response will be have a status of
GMSPlaceOpenStatusUnknownand error will contain information about the error.Declaration
Swift
typealiasGMSPlaceOpenStatusResponseCallback=(GMSPlaceIsOpenResponse,(anyError)?)->VoidObjective-C
typedefvoid(^GMSPlaceOpenStatusResponseCallback)(GMSPlaceIsOpenResponse*_Nonnull,NSError*_Nullable)Parameters
responseThe
GMSPlaceIsOpenResponsethat was returned.errorThe error that occurred, if any.
Callback type for receiving search by text results.
resultsis an array ofGMSPlacerepresenting individual results matching the query.Declaration
Swift
typealiasGMSPlaceSearchByTextResultCallback=([GMSPlace]?,(anyError)?)->VoidObjective-C
typedefvoid(^GMSPlaceSearchByTextResultCallback)(NSArray<GMSPlace*>*_Nullable,NSError*_Nullable)Parameters
resultsAn array of
GMSPlaces.errorThe error that occurred, if any.
Callback type for receiving a photo.
photoImageis aUIImagerepresenting the resulting photo matching the specified request. If an error occurred,photoImagewill be nil anderrorwill contain information about the error.Declaration
Swift
typealiasGMSFetchPhotoResultCallback=(UIImage?,(anyError)?)->VoidObjective-C
typedefvoid(^GMSFetchPhotoResultCallback)(UIImage*_Nullable,NSError*_Nullable)Parameters
photoImageA
UIImageresult.Callback type for autocomplete results.
Declaration
Swift
typealiasGMSAutocompleteSuggestionsCallback=([GMSAutocompleteSuggestion]?,(anyError)?)->VoidObjective-C
typedefvoid(^GMSAutocompleteSuggestionsCallback)(NSArray<GMSAutocompleteSuggestion*>*_Nullable,NSError*_Nullable)Parameters
resultsAn array of
GMSAutocompleteSuggestion.errorThe error that occurred, if any.
Callback type for receiving search nearby results.
Declaration
Swift
typealiasGMSPlaceSearchNearbyResultCallback=([GMSPlace]?,(anyError)?)->VoidObjective-C
typedefvoid(^GMSPlaceSearchNearbyResultCallback)(NSArray<GMSPlace*>*_Nullable,NSError*_Nullable)Parameters
placesAn array of
GMSPlaceerrorThe error that occurred, if any.
Callback type for receiving the search by text response.
responseisGMSPlaceSearchByTextResponserepresenting a list of places and other attributes about the places.Declaration
Swift
typealiasGMSPlaceSearchByTextResponseCallback=(GMSPlaceSearchByTextResponse?,(anyError)?)->VoidObjective-C
typedefvoid(^GMSPlaceSearchByTextResponseCallback)(GMSPlaceSearchByTextResponse*_Nullable,NSError*_Nullable)Parameters
responseSearch response containing a list of places and potential other attributes about the places.
errorThe error that occurred, if any.
Callback type for receiving search nearby response.
responseisGMSPlaceSearchNearbyResponserepresenting a list of places and other attributes about the places.Declaration
Swift
typealiasGMSPlaceSearchNearbyResponseCallback=(GMSPlaceSearchNearbyResponse?,(anyError)?)->VoidObjective-C
typedefvoid(^GMSPlaceSearchNearbyResponseCallback)(GMSPlaceSearchNearbyResponse*_Nullable,NSError*_Nullable)Parameters
responseSearch response containing a list of places and potential other attributes about the places.
errorThe error that occurred, if any.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-20 UTC.