GMSPlacesClient クラス リファレンス

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

概要

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

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

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

パブリック メンバーの関数

(void) - lookUpPlaceID:callback:
 場所の詳細情報を取得する。
(void) - fetchAutocompleteSuggestionsFromRequest: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) - isOpenWithRequest:callback:
 場所の営業状況を取得します。
(void) - isOpenWithPlaceID:callback:
 場所の詳細を取得します。これには、現在の時刻の GMSPlaceOpenStatus を特定するために必要なすべてのフィールドが含まれます。
(void) - isOpenWithPlaceID:date:callback:
 指定された NSDate の GMSPlaceOpenStatus を特定するために必要なすべてのフィールドを含む、場所の詳細を取得します。
(void) - isOpenWithPlace:callback:
 場所の詳細を取得します。これには、現在の時刻の GMSPlaceOpenStatus を特定するために必要なすべてのフィールドが含まれます。
(void) - isOpenWithPlace:date:callback:
 指定された NSDate の GMSPlaceOpenStatus を特定するために必要なすべてのフィールドを含む、場所の詳細を取得します。
(void) - searchByTextWithRequest:callback:
 テキストと制限を使用して場所を検索します。
(void) - fetchPlaceWithRequest:callback:
 リクエスト オブジェクトを使用して場所を取得します。
(void) - fetchPhotoWithRequest:callback:
 写真取得リクエストを使用して写真をリクエストします。
(void) - searchNearbyWithRequest:callback:
 指定した場所と制限の近くの場所を検索します。

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

(instancetype)+ sharedClient
 Google Places SDK for iOS 用に GMSPlacesClient の共有インスタンスを提供し、必要に応じて作成します。
（BOOL）+ provideAPIKey:
 作成した API キーを Google Places SDK for iOS に提供します。
(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 エラー)
 場所の可能性リストを受け取るためのコールバック タイプ。
typedef void(^GMSPlaceLikelihoodsCallback ）（NSArray< GMSPlaceLikelihood * > *_Nullable の可能性、NSError *_Nullable エラー）
 GMSPlaceLikelihood の配列を受け取るためのコールバック タイプ。
typedef void(^GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable 結果、NSError *_Nullable エラー)
 予測入力の結果を受け取るためのコールバック タイプ。
typedef void(^GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable エラー)
 場所の写真の結果を受け取るためのコールバック タイプ。
typedef void(^GMSPlacePhotoImageResultCallback )(UIImage *_Nullable photos, NSError *_Nullable エラー)
 GMSPlacePhotoMetadata オブジェクトから UIImage オブジェクトを受け取るためのコールバック タイプ。
typedef void(^GMSPlaceOpenStatusCallback )(GMSPlaceOpenStatus 結果, NSError *_Nullable エラー)
 場所の営業時間のステータスを受け取るためのコールバック タイプ。
typedef void(^GMSPlaceOpenStatusResponseCallback )(GMSPlaceIsOpenResponse *response, NSError *_Nullable エラー)
 オープン ステータス レスポンスを受信するためのコールバック タイプ。
typedef void(^GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable エラー)
 テキストによる検索の結果を受け取るためのコールバック タイプ。
typedef void(^GMSFetchPhotoResultCallback )(UIImage *_Nullable photoImage, NSError *_Nullable エラー)
 写真を受信するためのコールバック タイプ。
typedef void(^GMSAutocompleteSuggestionsCallback )(NSArray< GMSAutocompleteSuggestion * > *_Nullable の結果、NSError *_Nullable エラー)
 予測入力結果のコールバック タイプ。
typedef void(^GMSPlaceSearchNearbyResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable エラー)
 付近の検索結果を受け取るためのコールバック タイプ。

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

+（instancetype）sharedClient

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

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

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

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

このキーは 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
次のコールバックを使用します。 (GMSPlaceResultCallback) コールバック

場所の詳細情報を取得する。

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

パラメータ:
placeID検索するプレイス ID。
callbackルックアップ結果とともに呼び出すコールバック。
注:
これは非推奨です。このメソッドは fetchPlaceWithRequest:callback: に置き換えられました。今後のリリースで削除される予定です。
-（void）fetchAutocompleteSuggestionsFromRequest: （GMSAutocompleteRequest *） リクエスト
次のコールバックを使用します。 （GMSAutocompleteSuggestionsCallback） コールバック

テキストクエリから予測入力の候補を見つけます。

検索結果には、特定の地域を優先したり、特定の地域に限定したりすることもできます。このメソッドは非ブロックです。

成功すると予測入力の候補の配列とともに、指定されたコールバックが呼び出され、エラーになると NSError が呼び出されます。

パラメータ:
request予測入力の GMSAutocompleteRequest リクエスト。
callback候補とともに呼び出すコールバック。
- (void) LookUpPhotosForPlaceID: (NSString *)  placeID
次のコールバックを使用します。 （GMSPlacePhotoMetadataResultCallback） コールバック

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

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

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

このメソッドはネットワーク ルックアップを実行します。

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

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

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

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

特定の写真の画像を読み込みます。指定された最大サイズに合わせてスケーリングします。

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

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

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

注:
スケール係数を適用すると、maxSize のディメンションは最も近い整数に切り上げられてから使用されます。使用可能な最大サイズを超える画像がリクエストされた場合は、それより小さい画像が返されることがあります。
<ph type="x-smartling-placeholder">
</ph>
パラメータ:
photoMetadataUIImage を読み込む GMSPlacePhotoMetadata。
maxSize画像の最大サイズ。
WAF によるメリット画像を読み込む際のスケール。
callback読み込まれた UIImage で呼び出すコールバック。
- (void) currentPlaceWithCallback: (GMSPlaceLikelihoodListCallback) callback

デバイスの現在位置がわかっている場所の推定情報を返します。

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

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

テキストクエリから予測入力候補を見つけます。

検索結果には、特定の地域を優先したり、特定の地域に限定したりすることもできます。このメソッドは非ブロックです。

成功すると予測入力候補の配列とともに、指定されたコールバックが呼び出され、エラーになると NSError が呼び出されます。

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

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

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

パラメータ:
placeID検索するプレイス ID。
placeFieldsリスト内のプレイス オブジェクトに対してリクエストされる個々のプレイス フィールド。
sessionTokenリクエストを課金セッションに関連付ける GMSAutocompleteSessionToken。
callbackルックアップ結果とともに呼び出すコールバック。
注:
これは非推奨です。このメソッドは fetchPlaceWithRequest:callback: callback: に置き換えられました。今後のリリースで削除される予定です。
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: （GMSPlaceField） placeFields
次のコールバックを使用します。 (GMSPlaceLikelihoodsCallback) コールバック

ユーザーの現在地に基づいて、場所の可能性を検出します。

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

指定されたコールバックは、成功した場合は可能性スコア、エラーの場合は NSError を含む場所の配列で呼び出されます。

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

場所の営業状況（指定された NSDate の GMSPlaceOpenStatus を確認するために必要なすべてのプロパティを含む）を取得します。このメソッドは非ブロックです。

パラメータ:
isOpenRequest特定の場所の営業状況を確認するためのリクエストです。
callbackオープン ステータス レスポンスで呼び出すコールバック。
- (void) isOpenWithPlaceID: (NSString *)  placeID
次のコールバックを使用します。 （GMSPlaceOpenStatusCallback） コールバック

場所の営業状況を取得します。これには、現在の時刻の GMSPlaceOpenStatus を判断するために必要なすべてのフィールドが含まれます。

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

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

場所の営業状況（指定された NSDate の GMSPlaceOpenStatus を特定するために必要なすべてのフィールドを含む）を取得します。

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

パラメータ:
placeID検索するプレイス ID。
date営業状況を確認する NSDate。
callbackプレイスの結果とともに呼び出すコールバック。
- (void) isOpenWithPlace: （GMSPlace *） 場所
次のコールバックを使用します。 （GMSPlaceOpenStatusCallback） コールバック

場所の営業状況を取得します。これには、現在の時刻の GMSPlaceOpenStatus を判断するために必要なすべてのフィールドが含まれます。

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

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

指定された 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.

- (void) searchByTextWithRequest: （GMSPlaceSearchByTextRequest *） textSearchRequest
次のコールバックを使用します。 (GMSPlaceSearchByTextResultCallback) コールバック

テキストと制限を使用して場所を検索します。

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

パラメータ:
textSearchRequestGMSPlaceSearchByTextRequest: クエリに使用するテキスト リクエスト。
callbackルックアップ結果とともに呼び出すコールバック。
- (void) fetchPlaceWithRequest: （GMSFetchPlaceRequest *） fetchPlaceRequest
次のコールバックを使用します。 (GMSPlaceResultCallback) コールバック

リクエスト オブジェクトを使用して場所を取得します。

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

パラメータ:
fetchPlaceRequestGMSFetchPlaceRequest: クエリに使用する場所の取得リクエスト。
callbackプレイスの結果とともに呼び出すコールバック。
- (void) fetchPhotoWithRequest: （GMSFetchPhotoRequest *） fetchPhotoRequest
次のコールバックを使用します。 (GMSFetchPhotoResultCallback) コールバック

写真取得リクエストを使用して写真をリクエストします。

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

パラメータ:
fetchPhotoRequestGMSFetchPhotoRequest: 使用する写真リクエスト。
callbackNSURL の結果とともに呼び出すコールバック。
- (void) searchNearbyWithRequest: （GMSPlaceSearchNearbyRequest *） searchNearbyRequest
次のコールバックを使用します。 （GMSPlaceSearchNearbyResultCallback） コールバック

指定した場所と制限の近くの場所を検索します。

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

パラメータ:
searchNearbyRequestGMSPlaceSearchNearbyRequest: クエリに使用する Nearby Search リクエスト。
callbackルックアップ結果とともに呼び出すコールバック。
- (typedef void(^ GMSPlaceResultCallback)(GMSPlace *_Nullable result, NSError *_Nullable error)) [related]

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

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

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

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

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

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

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

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

- (typedef void(^ GMSAutocompletePredictionsCallback)(NSArray< GMSAutocompletePrediction * > *_Nullable results, NSError *_Nullable エラー)) [related]

予測入力の結果を受け取るためのコールバック タイプ。

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

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

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

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

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

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

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

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

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

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

パラメータ:
件の結果返された GMSPlaceOpenStatus。
エラー発生したエラー（ある場合）。
- (typedef void(^ GMSPlaceOpenStatusResponseCallback)(GMSPlaceIsOpenResponse *response, NSError *_Nullable error)) [related]

オープン ステータス レスポンスを受信するためのコールバック タイプ。

エラーが発生した場合、レスポンスは GMSPlaceOpenStatusUnknown のステータスとなり、error にはエラーに関する情報が含まれます。

パラメータ:
レスポンス返された GMSPlaceIsOpenResponse。
エラー発生したエラー（ある場合）。
- (typedef void(^ GMSPlaceSearchByTextResultCallback)(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable エラー)) [related]

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

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

パラメータ:
結果GMSPlace の配列。
エラー発生したエラー（ある場合）。
- (typedef void(^ GMSFetchPhotoResultCallback)(UIImage *_Nullable photoImage, NSError *_Nullable error)) [related]

写真を受信するためのコールバック タイプ。

photoImage は、指定されたリクエストに一致する結果の写真を表す UIImage です。エラーが発生した場合、photoImage は nil になり、error にはエラーに関する情報が含まれます。

パラメータ:
photoImageUIImage の結果。
- (typedef void(^ GMSAutocompleteSuggestionsCallback)(NSArray< GMSAutocompleteSuggestion * > *_Nullable results, NSError *_Nullable error)) [related]

予測入力結果のコールバック タイプ。

パラメータ:
結果GMSAutocompleteSuggestion の配列。
エラー発生したエラー（ある場合）。
- (typedef void(^ GMSPlaceSearchNearbyResultCallback)(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable エラー)) [related]

付近の検索結果を受け取るためのコールバック タイプ。

パラメータ:
場所GMSPlace の配列
エラー発生したエラー（ある場合）。