GMSPlacesClient クラス リファレンス

パブリック メンバー関数 | 静的パブリック メンバー関数 | 関連関数
GMSPlacesClient クラス リファレンス

概要

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

場所の検索と詳細の取得に使用されます。このクラスには [GMSPlacesClient sharedClient] メソッドを介してアクセスする必要があります。

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

パブリック メンバー関数

(void) - lookUpPlaceID:callback:
 場所の詳細情報を取得します。
(void) - lookUpPhotosForPlaceID:callback:
 場所に関連する写真（最大 10 枚）のメタデータを取得します。
(void) - loadPlacePhoto:callback:
 特定の写真を最大サイズで読み込みます。
(void) - loadPlacePhoto:constraintToSize: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
 iOS 向け Google プレイス SDK の共有用 GMSPlacesClient を提供し、必要に応じて作成します。
（ブール値）+ provideAPIKey:
 iOS 向け Google Places SDK に 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 result、NSError *_Nullable error）
 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）
 GMSPlacePhotoMetadata オブジェクトから UIImage オブジェクトを受け取るコールバック タイプ。
typedef void(^ （GMSPlaceOpenStatusCallback）（GMSPlaceOpenStatus の結果、NSError *_Nullable エラー）
 Place の営業時間のステータスを受け取るコールバック タイプ。

メンバー関数に関するドキュメント

+（インスタンス タイプ）sharedClient

iOS 向け Google プレイス SDK の共有用 GMSPlacesClient を提供し、必要に応じて作成します。

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

+（BOOL）provideAPIKey: (NSString *)  key

iOS 向け Google Places SDK に 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

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

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

スケール パラメータが 1.0 でない場合、maxSize にこの値を掛けた値が UIImage に設定されます。画面で表示するための画像を読み込む場合は、このパラメータを画面サイズに設定します。

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

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

デバイスが現在知られている場所の推定値を返します。

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

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

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

検索結果には、特定の地域に対する制約や特定の地域への制限が設けられている場合があります。この方法は非ブロッキングです。

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

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

場所の詳細を取得する。

この方法は非ブロッキングです。

パラメータ:
placeID照合する場所 ID
placeFieldsリスト内の場所オブジェクトにリクエストされる個々の場所フィールド。
セッション トークンリクエストを請求セッションに関連付ける 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
dateNSDate がオープン ステータスを判別するためのステータス。
callback場所の結果で呼び出すコールバック。
- (void) isOpenWithPlace: （GMSPlace *） 場所
コールバック: （GMSPlaceOpenStatusCallback） callback

場所の詳細情報を取得します。これには、現在の GMSPlaceOpenStatus を特定するために必要なすべてのフィールドが含まれます。

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

パラメータ:
場所検索対象の GMSPlace。
callback場所の結果で呼び出すコールバック。
- (void) isOpenWithPlace: （GMSPlace *） 場所
日付: （NSDate *） date
コールバック: （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 にはエラーに関する情報が格納されます。

パラメータ:
可能性リスト場所の候補リスト。
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 photos, NSError *_Nullable error) [related]

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

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

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

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

エラーが発生した場合、result は GMSPlaceOpenStatusUnknownUnknown に存在し、error にはエラーに関する情報が含まれます。

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