Get Started Contact sales

GooglePlaces Framework Reference

  • GMSFetchPlaceRequest objects are used with GMSPlacesClient to fetch details about a specific place using its ID.

  • Requests must specify the placeID and desired placeProperties to retrieve data fields for the place.

  • An optional sessionToken can be included to associate the request with a billing session, particularly useful for autocomplete queries.

  • The default init method is unavailable; use initWithPlaceID:placeProperties:sessionToken: to create a request instance.

  • The requested placeProperties array cannot be empty; otherwise, an error will occur when sending the request.

GMSFetchPlaceRequest

@interface GMSFetchPlaceRequest : NSObject

Request object to use with GMSPlacesClient to fetch a place.

  • Request object to use with GMSPlacesClient to fetch a place.

    Declaration

    Swift

    init(placeID: String, placeProperties: [String], sessionToken: GMSAutocompleteSessionToken?)

    Objective-C

    - (nonnull instancetype)
    initWithPlaceID:(nonnull NSString *)placeID
    placeProperties:(nonnull NSArray<NSString *> *)placeProperties
       sessionToken:(nullable GMSAutocompleteSessionToken *)sessionToken;

    Parameters

    placeID

    The ID of the place to be requested.
    placeProperties

    The properties of the place to be requested. Must not be empty. An empty list will result in an error when trying to send the request. Read more about Place Data Fields.
    sessionToken

    The GMSAutocompleteSessionToken to associate request to a billing session.

  • Unavailable

    Default init is not available. Please use the designated initializer.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Place ID of the place being requested.

    Declaration

    Swift

    var placeID: String { get }

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull placeID;

  • Place properties to include in the GMSPlace response. Must not be empty. An empty list will result in an error when trying to send the request.

    Declaration

    Swift

    var placeProperties: [String] { get }

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<NSString *> *_Nonnull placeProperties;

  • Session token to associate request to a billing session.

    Declaration

    Swift

    @NSCopying var sessionToken: GMSAutocompleteSessionToken? { get }

    Objective-C

    @property (nonatomic, copy, readonly, nullable) GMSAutocompleteSessionToken *sessionToken;