GMSPlacesClient クラス リファレンス

パブリック メンバー関数 | 静的パブリック メンバー関数 | 関連関数
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 を特定するために必要なすべてのフィールドを含む、場所の詳細を取得します。
(void) - searchByTextWithRequest:callback:
 テキストと制限に基づいて場所を検索します。

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

（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 error)
 GMSPlaceLikelihood の配列を受け取るコールバック タイプ。
typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable results、NSError *_Nullable error)
 オートコンプリートの結果を受け取るためのコールバック タイプ。
typedef void(^ GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)
 場所の写真の結果を受け取るためのコールバック タイプ。
typedef void(^ GMSPlacePhotoImageResultCallback )(UIImage *_Nullable 枚の写真、NSError *_Nullable error)
 GMSPlacePhotoMetadata オブジェクトから UIImage オブジェクトを受け取るコールバック タイプ。
typedef void(^ GMSPlaceOpenStatusCallback )(GMSPlaceOpenStatus 結果、NSError *_Nullable エラー)
 プレイスの営業時間のステータスを受け取るためのコールバック タイプ。
typedef void(^ GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable プレイス、NSError *_Nullable エラー)
 テキスト結果による検索を受信するためのコールバック タイプ。

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

+ (instancetype) sharedClient

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

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

+ (BOOL) provideAPIKey: (NSString *)  キー

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

このキーは、Google Cloud Platform Console でアプリケーション用に生成され、アプリケーションのバンドル 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
使用します。 （GMSPlaceResultCallback） callback

場所の詳細を取得する。

この方法は非ブロックです。

パラメータ:
placeID検索するプレイス ID。
callback検索結果とともに呼び出すコールバック。
- (void) lookUpPhotosForPlaceID: (NSString *)  placeID
使用します。 （GMSPlacePhotoMetadataResultCallback） callback

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

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

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

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

パラメータ:
placeID写真を検索するためのプレイス ID。
callback検索結果とともに呼び出すコールバック。
- (void) loadPlacePhoto: （GMSPlacePhotoMetadata *） photoMetadata
使用します。 （GMSPlacePhotoImageResultCallback） callback

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

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

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

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

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

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

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

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

デバイスが現在位置していることが判明しているおおよその場所を返します。

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

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

テキストクエリからオートコンプリート候補を検索します。

特定の場所を優先したり、特定の地域に限定したりすることもできます。この方法は非ブロックです。

成功すると、指定されたコールバックがオートコンプリート予測の配列とともに呼び出されます。エラーの場合は NSError が返されます。

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

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

この方法は非ブロックです。

パラメータ:
placeID検索するプレイス ID。
placeFieldsリスト内のプレイス オブジェクトに対してリクエストされる個々のプレイス フィールド。
sessionTokenリクエストを課金セッションに関連付ける GMSAutocompleteSessionToken。
callback検索結果とともに呼び出すコールバック。
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: （GMSPlaceField） placeFields
使用します。 （GMSPlaceLikelihoodsCallback） callback

ユーザーの現在地から場所の可能性を検出します。

この方法は非ブロックです。

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

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

場所の詳細（現在の時刻の GMSPlaceOpenStatus の特定に必要なすべてのフィールドを含む）を取得します。

この方法は非ブロックです。

パラメータ:
placeID検索するプレイス ID。
callback場所の結果で呼び出すコールバック。
- (void) isOpenWithPlaceID: (NSString *)  placeID
日付: （NSDate *） date
使用します。 （GMSPlaceOpenStatusCallback） callback

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

この方法は非ブロックです。

パラメータ:
placeID検索するプレイス ID。
dateオープン ステータスを判別する NSDate。
callback場所の結果で呼び出すコールバック。
- (void) isOpenWithPlace: （GMSPlace *） 場所
使用します。 （GMSPlaceOpenStatusCallback） callback

場所の詳細（現在の時刻の GMSPlaceOpenStatus の特定に必要なすべてのフィールドを含む）を取得します。

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

パラメータ:
場所検索する GMSPlace。
callback場所の結果で呼び出すコールバック。
- (void) isOpenWithPlace: （GMSPlace *） 場所
日付: （NSDate *） date
使用します。 （GMSPlaceOpenStatusCallback） callback

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

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

パラメータ:
場所検索する GMSPlace。
dateオープン ステータスを判別する NSDate。
callback場所の結果で呼び出すコールバック。
- (void) searchByTextWithRequest： （GMSPlaceSearchByTextRequest *） textSearchRequest
使用します。 （GMSPlaceSearchByTextResultCallback） callback

テキストと制限に基づいて場所を検索します。

この方法は非ブロックです。

パラメータ:
textSearchRequestGMSPlaceSearchByTextRequest: クエリに使用するテキスト リクエスト。
callback検索結果とともに呼び出すコールバック。
- (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 results, 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 error)) [related]

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

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

パラメータ:
件の結果返された GMSPlaceOpenStatus。
error発生したエラー（エラーが存在する場合）。
- (typedef void(^ GMSPlaceSearchByTextResultCallback)(NSArray< GMSPlace * > *_Nullable place, NSError *_Nullable error)) [related]

テキスト結果による検索を受信するためのコールバック タイプ。

results は、クエリに一致する個々の結果を表す GMSPlace の配列です。

パラメータ:
結果GMSPlace の配列。
error発生したエラー（エラーが存在する場合）。