New pricing and product changes will go into effect starting June 11, 2018. For more information, check out the Guide for Existing Users.

GMSServices Class Reference

GMSServices Class Reference

Overview

Service class for the Google Maps SDK for iOS.

This class is not thread safe. All methods should only be invoked on the main thread.

Static Public Member Functions

(id< NSObject >) + sharedServices
 Provides the shared instance of GMSServices for the Google Maps SDK for iOS, creating it if necessary.
(BOOL) + provideAPIKey:
 Provides your API key to the Google Maps SDK for iOS.
(BOOL) + provideAPIOptions:
 Provides your API options to the Google Maps SDK for iOS.
(NSString *) + openSourceLicenseInfo
 Returns the open source software license information for Google Maps SDK for iOS.
(NSString *) + SDKVersion
 Returns the version for this release of the Google Maps SDK for iOS.

Member Function Documentation

+ (id<NSObject>) sharedServices

Provides the shared instance of GMSServices for the Google Maps SDK for iOS, creating it if necessary.

Classes such as GMSMapView and GMSPanoramaView will hold this instance to provide their connection to Google.

This is an opaque object. If your application often creates and destroys view or service classes provided by the Google Maps SDK for iOS, it may be useful to hold onto this object directly, as otherwise your connection to Google may be restarted on a regular basis. It also may be useful to take this object in advance of the first map creation, to reduce initial map creation performance cost.

This method will throw an exception if provideAPIKey: has not been called.

+ (BOOL) provideAPIKey: (NSString *)  APIKey

Provides your API key to the Google Maps SDK for iOS.

This key is generated for your application via the Google APIs Console, and is paired with your application's bundle ID to identify it. This must be called exactly once by your application before any iOS Maps SDK object is initialized.

Returns:
YES if the APIKey was successfully provided.
+ (BOOL) provideAPIOptions: (NSArray< NSString * > *)  APIOptions

Provides your API options to the Google Maps SDK for iOS.

Pass an array containing an NSString for each option. These options apply to all maps.

This may be called exactly once by your application and must be called before any iOS Maps SDK object is initialized.

Returns:
YES if all the APIOptions were successfully provided.
+ (NSString *) openSourceLicenseInfo

Returns the open source software license information for Google Maps SDK for iOS.

This information must be made available within your application.

+ (NSString *) SDKVersion

Returns the version for this release of the Google Maps SDK for iOS.

Send feedback about...

Maps SDK for iOS
Maps SDK for iOS
Need help? Visit our support page.