GMSPlacesClient クラス リファレンス


概要

Places SDK のメイン インターフェース。

場所の検索と詳細情報の取得に使用されます。このクラスにアクセスするには、[GMSPlacesClient sharedClient] メソッドを使用します。

GMSPlacesClient メソッドは、メインスレッドからのみ呼び出す必要があります。別のスレッドからこれらのメソッドを呼び出すと、例外または未定義の動作が発生します。特に指定しない限り、コールバックはすべてメインスレッドで呼び出されます。

パブリック メンバー関数

(void) - lookUpPlaceID:callback:
 場所の詳細を取得します。
(void) - lookUpPhotosForPlaceID:callback:
 場所に関連付けられた最大 10 枚の写真のメタデータを取得します。
(void) - loadPlacePhoto:callback:
 特定の写真の画像を最大サイズで読み込みます。
(void) - loadPlacePhoto:constrainedToSize:scale:callback:
 特定の写真の画像を、指定された最大サイズに合わせて拡大縮小して読み込みます。
(void) - currentPlaceWithCallback:
 デバイスの位置が判明している場所の推定値を返します。
(void) - findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
 テキストクエリからオートコンプリート候補を見つけます。
(void) - fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
 場所の詳細を取得します。
(void) - findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
 ユーザーの現在地から場所の可能性を見つけます。
(void) - isOpenWithPlaceID:callback:
 場所の詳細情報(現在の時刻の GMSPlaceOpenStatus を判別するために必要なすべてのフィールドを含む)を取得します。
(void) - isOpenWithPlaceID:date:callback:
 場所の詳細情報(指定された NSDate にある GMSPlaceOpenStatus を特定するために必要なすべてのフィールドを含む)を取得します。
(void) - isOpenWithPlace:callback:
 場所の詳細情報(現在の時刻の GMSPlaceOpenStatus を判別するために必要なすべてのフィールドを含む)を取得します。
(void) - isOpenWithPlace:date:callback:
 場所の詳細情報(指定された NSDate にある GMSPlaceOpenStatus を特定するために必要なすべてのフィールドを含む)を取得します。

静的パブリック メンバー関数

(instancetype)+ sharedClient
 Google Places SDK for iOS の GMSPlacesClient の共有インスタンスを提供し、必要に応じて作成します。
(BOOL) + provideAPIKey:
 Google Places SDK for iOS に API キーを提供します。
(NSString *) + openSourceLicenseInfo
 Google Places SDK for iOS のオープンソース ソフトウェア ライセンス情報を返します。
(NSString *) + SDKVersion
 Google Places SDK for iOS のこのリリースのバージョンを返します。
(NSString *) + SDKLongVersion
 Google Places SDK for iOS のこのリリースの長いバージョンを返します。

(これらはメンバー関数ではないことに注意してください)。

typedef void(^ GMSPlaceResultCallback )(GMSPlace *_Nullable 結果、NSError *_Nullable エラー)
 Place Details のルックアップを受信するためのコールバック タイプ。
typedef void(^ GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_Nullable likelihoodList、NSError *_Nullable error)
 場所の可能性リストを受け取るためのコールバック タイプ。
typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable likelihoods、NSError *_Nullable エラー)
 GMSPlaceLikelihood の配列を受け取るためのコールバック型。
typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable 結果、NSError *_Nullable エラー)
 オートコンプリートの結果を受け取るためのコールバック タイプ。
typedef void(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable 写真、NSError *_Nullable エラー)
 場所の写真に関する結果を受け取るためのコールバック タイプ。
typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable 枚の写真、NSError *_Nullable エラー)
 GMSPlacePhotoMetadata オブジェクトから UIImage オブジェクトを受け取るためのコールバック タイプ。
typedef void(^ GMSPlaceOpenStatusCallback)(GMSPlaceOpenStatus 結果、NSError *_Nullable エラー)
 場所の営業時間のステータスを受け取るためのコールバック タイプ。

メンバー関数のドキュメント

+ (instancetype) sharedClient

Google Places SDK for iOS の GMSPlacesClient の共有インスタンスを提供し、必要に応じて作成します。

アプリケーションで GMSPlacesClient のメソッドを頻繁に使用する場合は、このオブジェクトを直接保持することをおすすめします。そうしないと、Google への接続が定期的に再起動される場合があります。

+ (BOOL) provideAPIKey: (NSString *)  key

Google Places SDK for iOS に API キーを提供します。

このキーは、Google Cloud Platform コンソールを介してアプリケーション用に生成され、アプリケーションのバンドル ID とペアで識別されます。これは、GMSPlacesClient を使用する前に、アプリケーションで呼び出す必要があります(たとえば application:didFinishLaunchingWithOptions: の場合)。

戻り値:
APIKey が正常に提供された場合は YES。
+(NSString *)openSourceLicenseInfo

Google Places SDK for iOS のオープンソース ソフトウェア ライセンス情報を返します。

この情報は、アプリケーション内で利用できるようにする必要があります。

+ (NSString *) SDKVersion

Google Places SDK for iOS のこのリリースのバージョンを返します。

。たとえば、「1.0.0」です。

+ (NSString *) SDKLongVersion

Google Places SDK for iOS のこのリリースの長いバージョンを返します。

例: 「1.0.0 (102.1)」

- (void) lookUpPlaceID: (NSString *)  placeID
call GMSPlaceResultCallback callback

場所の詳細を取得します。

このメソッドは非ブロックです。

パラメータ:
placeID検索するプレイス ID。
callbackルックアップ結果で呼び出すコールバック。
- (void) lookUpPhotosForPlaceID: (NSString *)  placeID
call GMSPlacePhotoMetadataResultCallback callback

場所に関連付けられた最大 10 枚の写真のメタデータを取得します。

写真は、ビジネス オーナーや Google+ ユーザーが投稿した写真など、さまざまな場所から取得されます。こういった写真は、帰属情報なしで使用できる場合や、必要な帰属情報が画像内にあらかじめ記載されている場合がほとんどです。ただし、必要な追加の帰属情報を取得するために、レスポンスの attributions プロパティを使用して、画像を表示するすべての場所にそれらの帰属情報を表示する必要があります。最大 10 枚の写真が返されます。

このメソッドを複数回呼び出すと、毎回同じ写真が返される可能性があります。ただし、基になるデータが変更された可能性があるため、更新が保証されるわけではありません。

このメソッドはネットワーク検索を実行します。

パラメータ:
placeID写真を検索するプレイス ID。
callbackルックアップ結果で呼び出すコールバック。
- (void) loadPlacePhoto: GMSPlacePhotoMetadata *) photoMetadata
call GMSPlacePhotoImageResultCallback callback

特定の写真の画像を最大サイズで読み込みます。

画像データは SDK によってキャッシュされる場合があります。リクエストされた写真がキャッシュに存在しない場合は、ネットワーク検索が実行されます。

パラメータ:
photoMetadataUIImage を読み込む GMSPlacePhotoMetadata
callback読み込まれた UIImage で呼び出すコールバック。
- (void) loadPlacePhoto: GMSPlacePhotoMetadata *) photoMetadata
constraintToSize: (CGSize) maxSize
考えられます。 (CGFloat) スケール
call GMSPlacePhotoImageResultCallback callback

特定の写真の画像を、指定された最大サイズに合わせて拡大縮小して読み込みます。

画像は、元の画像のアスペクト比を維持しながら、指定されたサイズに収まるように拡大縮小されます。このスケーリングはサーバーサイドで行われます。

scale パラメータが 1.0 ではない場合、maxSize にこの値が乗算され、返される UIImage は指定された縮尺に設定されます。画面に表示する画像を読み込む場合は、このパラメータを画面スケールに設定する必要があります。

画像データは SDK によってキャッシュされる場合があります。リクエストされた写真がキャッシュに存在しない場合は、ネットワーク検索が実行されます。

注:
スケーリング ファクタを適用すると、maxSize の寸法は、使用前に最も近い整数に切り上げられます。利用可能な最大サイズより大きい画像がリクエストされた場合は、それより小さい画像が返されることがあります。
パラメータ:
photoMetadataUIImage を読み込む GMSPlacePhotoMetadata
maxSize画像の最大サイズ。
WAF によるメリット画像を読み込むスケール。
callback読み込まれた UIImage で呼び出すコールバック。

デバイスの位置が判明している場所の推定値を返します。

デバイスの最新の推定位置情報に基づいて、場所の可能性リストを生成します。指定したコールバックは、成功時にはこの可能性リストで呼び出され、エラー時には NSError で呼び出されます。

注:
このメソッドを使用するには、デバイスの位置情報にアクセスする権限をアプリに付与する必要があります。このメソッドを呼び出す前に、[CLLocationManager requestWhenInUseAuthorization] または [CLLocationManager requestAlwaysAuthorization] を使用して、ユーザーの位置情報へのアクセスをリクエストしてください。このメソッドを呼び出してもアプリの認証ステータスが適切でない場合、コールバックはエラーで呼び出されます。
パラメータ:
callback場所の可能性リストとともに呼び出すコールバック。
- (void) findAutocompletePredictionsFromQuery: (NSString *)  query
filter: (null 許容 GMSAutocompleteFilter *) filter
sessionToken: (null 許容の GMSAutocompleteSessionToken *) sessionToken
call GMSAutocompletePredictionsCallback callback

テキストクエリからオートコンプリート候補を見つけます。

必要に応じて、特定の地域を優先したり、特定の地域に限定したりすることもできます。このメソッドは非ブロックです。

指定されたコールバックは、成功時にはオートコンプリート予測の配列で呼び出され、エラー時には NSError で呼び出されます。

パラメータ:
クエリオートコンプリートするテキストの一部。
フィルタ結果に適用するフィルタ。このパラメータは nil にすることもできます。
sessionTokenリクエストを請求セッションに関連付ける GMSAutocompleteSessionToken
callback予測とともに呼び出すコールバック。
- (void) fetchPlaceFromPlaceID: (NSString *)  placeID
placeFields: GMSPlaceField placeFields
sessionToken: (null 許容の GMSAutocompleteSessionToken *) sessionToken
call GMSPlaceResultCallback callback

場所の詳細を取得します。

このメソッドは非ブロックです。

パラメータ:
placeID検索するプレイス ID。
placeFieldsリスト内のプレイス オブジェクトについてリクエストされる個々のプレイス フィールド。
sessionTokenリクエストを請求セッションに関連付ける GMSAutocompleteSessionToken
callbackルックアップ結果で呼び出すコールバック。
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: GMSPlaceField placeFields
call GMSPlaceLikelihoodsCallback callback

ユーザーの現在地から場所の可能性を見つけます。

このメソッドは非ブロックです。

指定されたコールバックは、成功時には可能性スコアを含み、エラー時には NSError をもつ場所の配列とともに呼び出されます。

パラメータ:
placeFieldsリスト内のプレイス オブジェクトについてリクエストされる個々のプレイス フィールド。
callback場所の可能性を指定して呼び出すコールバック。
- (void) isOpenWithPlaceID: (NSString *)  placeID
call GMSPlaceOpenStatusCallback callback

場所の詳細情報(現在の時刻の GMSPlaceOpenStatus を判別するために必要なすべてのフィールドを含む)を取得します。

このメソッドは非ブロックです。

パラメータ:
placeID検索するプレイス ID。
callback場所の結果とともに呼び出すコールバック。
- (void) isOpenWithPlaceID: (NSString *)  placeID
日付: (NSDate *) date
call GMSPlaceOpenStatusCallback callback

場所の詳細情報(指定された NSDate にある GMSPlaceOpenStatus を特定するために必要なすべてのフィールドを含む)を取得します。

このメソッドは非ブロックです。

パラメータ:
placeID検索するプレイス ID。
dateオープンのステータスを判別するための NSDate
callback場所の結果とともに呼び出すコールバック。
- (void) isOpenWithPlace: GMSPlace *) 場所
call GMSPlaceOpenStatusCallback callback

場所の詳細情報(現在の時刻の GMSPlaceOpenStatus を判別するために必要なすべてのフィールドを含む)を取得します。

GMSPlace に必要なフィールドがすべて揃っていない場合にのみ、追加フィールドをリクエストします。それ以外の場合は、コールバックで GMSPlaceOpenStatus がすぐに返されます。このメソッドは非ブロックです。

パラメータ:
場所検索する GMSPlace
callback場所の結果とともに呼び出すコールバック。
- (void) isOpenWithPlace: GMSPlace *) 場所
日付: (NSDate *) date
call GMSPlaceOpenStatusCallback callback

場所の詳細情報(指定された NSDate にある GMSPlaceOpenStatus を特定するために必要なすべてのフィールドを含む)を取得します。

GMSPlace に必須フィールドがすべて揃っていない場合にのみ、追加のフィールドをリクエストします。それ以外の場合は 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.


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

Place Details のルックアップを受信するためのコールバック タイプ。

エラーが発生した場合、result は nil となり、error にエラーに関する情報が格納されます。

パラメータ:
件の結果返された GMSPlace
error発生したエラー(ある場合)。
- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_Nullable likelihoodList, NSError *_Nullable error)) [related]

場所の可能性リストを受け取るためのコールバック タイプ。

エラーが発生した場合、likelihoodList は nil となり、error にエラーに関する情報が格納されます。

パラメータ:
likelihoodList場所の可能性のリスト。
error発生したエラー(ある場合)。
- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullable likelihoods、NSError *_Nullable error)) [related]

GMSPlaceLikelihood の配列を受け取るためのコールバック型。

エラーが発生した場合、配列は nil になり、error にエラーに関する情報が格納されます。

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

オートコンプリートの結果を受け取るためのコールバック タイプ。

results は、クエリの完了候補を表す GMSAutocompletePredictions の配列です。

パラメータ:
結果GMSAutocompletePrediction の配列。
error発生したエラー(ある場合)。
- (typedef void(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)) [related]

場所の写真に関する結果を受け取るためのコールバック タイプ。

エラーが発生した場合、photos は nil となり、error にエラーに関する情報が格納されます。

パラメータ:
写真GMSPlacePhotoMetadata オブジェクトを含む結果。
error発生したエラー(ある場合)。
- (typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable photo, NSError *_Nullable error)) [related]

GMSPlacePhotoMetadata オブジェクトから UIImage オブジェクトを受け取るためのコールバック タイプ。

エラーが発生した場合、photo は nil となり、error にエラーに関する情報が格納されます。

パラメータ:
写真読み込まれた UIImage
error発生したエラー(ある場合)。
- (typedef void(^ GMSPlaceOpenStatusCallback)(GMSPlaceOpenStatus 結果、NSError *_Nullable エラー)) [related]

場所の営業時間のステータスを受け取るためのコールバック タイプ。

エラーが発生した場合、result は GMSPlaceOpenStatusUnknown となり、error にエラーに関する情報が格納されます。

パラメータ:
件の結果返された GMSPlaceOpenStatus
error発生したエラー(ある場合)。