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
	提供GMSPlacesClient適用於 Google Places SDK for iOS 的共享實例，視需要建立該實例。
(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 啟發 List, NSError *_Nullable error)
	用於接收地點可能性清單的回呼類型。
typedef void(^)	GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable 可能 s, NSError *_Nullable error)
	用於接收 GMSPlaceLikelihood 陣列的回呼類型。
typedef void(^)	GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable 結果, NSError *_Nullable error)
	接收自動完成結果的回呼類型。
typedef void(^)	GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)
	接收地點相片搜尋結果的回呼類型。
typedef void(^)	GMSPlacePhotoImageResultCallback )(UIImage *_Nullable Photo, NSError *_Nullable error)
	從 GMSPlacePhotoMetadata 物件接收 UIImage 物件的回呼類型。
typedef void(^)	GMSPlaceOpenStatusCallback )(GMSPlaceOpenStatus 結果，NSError *_Nullable 錯誤)
	用於接收地點營業時間狀態的回呼類型。
typedef void(^)	GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)
	用於接收文字搜尋結果搜尋結果的回呼類型。

---

成員函式說明文件

+ (instancetype) sharedClient

提供GMSPlacesClient適用於 Google Places SDK for iOS 的共享實例，視需要建立該實例。

如果您的應用程式經常使用 GMSPlacesClient 的方法，那麼請直接持有這個物件，因為您與 Google 的連線可能會定期重新啟動。

+ (BOOL) provideAPIKey：

(NSString *)

鍵

將 API 金鑰提供給 Google Places SDK for iOS。

這組金鑰是透過 Google Cloud Platform 主控台為您的應用程式產生，並與應用程式的軟體包 ID 配對，以方便識別。您的應用程式應在使用 GMSPlacesClient 前呼叫此（例如， application:didFinishLaunchingWithOptions:）。

傳回：

如果已成功提供 APIKey，則為「是」。

+ (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。
回呼	對查詢結果叫用的回呼。

- (void) LookUpPhotosForPlaceID：		(NSString *)	placeID
回呼：		(GMSPlacePhotoMetadataResultCallback)	回呼

取得與某個地點相關的最多 10 張相片的中繼資料。

相片取自各種地點，包括業主和 Google+ 使用者提供的相片。在大多數情況下，使用這些相片時可以不包含作者資訊，圖片本身也可能加上必要的作者資訊。不過，您必須在回應中使用 attributions 屬性以擷取任何其他所需的作者資訊，並在每次顯示圖片時在應用程式中顯示這些作者資訊。最多可傳回 10 張相片。

多次呼叫這個方法可能會每次都傳回相同的相片。不過，基礎資料可能已有所變動，因此不保證會達成。

這個方法會執行網路查詢。

參數：

placeID	要查詢相片的地點 ID。
回呼	對查詢結果叫用的回呼。

- (void) loadPlacePhoto：		(GMSPlacePhotoMetadata *)	photoMetadata
回呼：		(GMSPlacePhotoImageResultCallback)	回呼

以最大尺寸載入特定相片的圖片。

SDK 可快取圖片資料。如果要求的相片不存在於快取中，系統會執行網路查詢。

參數：

photoMetadata	用於載入 UIImage 的 GMSPlacePhotoMetadata。
回呼	透過已載入的 UIImage 叫用的回呼。

- (void) loadPlacePhoto：		(GMSPlacePhotoMetadata *)	photoMetadata
limitedToSize：		(CGSize)	maxSize
比例：		(CGFloat)	scale
回呼：		(GMSPlacePhotoImageResultCallback)	回呼

載入特定相片的圖片，配合指定的最大尺寸調整大小。

系統會將圖片調整為符合指定的尺寸，同時維持原始圖片的長寬比。這項資源調度作業是在伺服器端執行。

如果 scale 參數不是 1.0 maxSize，系統會將這個值乘以此值，而傳回的 UIImage 會設定為包含指定的比例。如果您要載入圖片以供在螢幕上顯示，則應將這個參數設定為螢幕比例。

SDK 可快取圖片資料。如果要求的相片不存在於快取中，系統會執行網路查詢。

注意：

套用比例因數後，maxSize 中的尺寸會無條件進位至最接近的整數，然後再使用。如果請求的圖片超過可用大小上限，系統可能會傳回較小的圖片。

參數：

photoMetadata	用於載入 UIImage 的 GMSPlacePhotoMetadata。
maxSize	圖片的大小上限。
的保護	載入圖片的比例。
回呼	透過已載入的 UIImage 叫用的回呼。

- (void) currentPlaceWithCallback：

(GMSPlaceLikelihoodListCallback)

回呼

傳回裝置目前已知位置的預估值。

根據裝置最新的概略位置，產生可能的地點可能清單。成功時，系統會透過這個可能性清單叫用所提供的回呼，並在發生錯誤時發出 NSError。

注意：

如要使用這個方法，應用程式必須有權存取目前裝置的位置資訊。呼叫此方法前，請務必先使用 [CLLocationManager requestWhenInUseAuthorization] 或 [CLLocationManager requestAlwaysAuthorization] 要求存取使用者的位置資訊。如果呼叫此方法，而應用程式沒有正確的授權狀態，系統就會呼叫回呼並顯示錯誤。

參數：

回呼	透過地點可能性清單叫用的回呼。

- (void) findAutocompletePredictionsFromQuery：		(NSString *)	查詢
篩選器：		(可為空值GMSAutocompleteFilter *)	篩選器
sessionToken：		(可為空值GMSAutocompleteSessionToken *)	sessionToken
回呼：		(GMSAutocompletePredictionsCallback)	回呼

根據文字查詢找出自動完成預測。

您可以選擇將結果自訂調整至特定位置，或是限制為特定區域。這是非封鎖式方法。

成功時，系統會利用自動完成預測的陣列叫用所提供的回呼，並在發生錯誤時呼叫 NSError。

參數：

項查詢	要自動完成的部分文字。
過濾器	要套用至結果的篩選器。這個參數可以為 nil。
sessionToken	將要求與帳單工作階段建立關聯的 GMSAutocompleteSessionToken。
回呼	透過預測叫用的回呼。

- (void) capturePlaceFromPlaceID：		(NSString *)	placeID
placeFields：		(GMSPlaceField)	placeFields
sessionToken：		(可為空值GMSAutocompleteSessionToken *)	sessionToken
回呼：		(GMSPlaceResultCallback)	回呼

擷取地點詳細資料。

這是非封鎖式方法。

參數：

placeID	要查詢的地點 ID。
placeFields	針對清單中地點物件要求的個別地點欄位。
sessionToken	將要求與帳單工作階段建立關聯的 GMSAutocompleteSessionToken。
回呼	對查詢結果叫用的回呼。

- (void) findPlacelikelihoodsFromCurrentLocationWithPlaceFields:		(GMSPlaceField)	placeFields
回呼：		(GMSPlaceLikelihoodsCallback)	回呼

根據使用者目前的所在位置尋找可能的地點。

這是非封鎖式方法。

提供的回呼將由一組地點陣列 (成功時分數) 和 NSError 產生。

參數：

placeFields	針對清單中地點物件要求的個別地點欄位。
回呼	使用地點可能性叫用的回呼。

- (void) isOpenWithPlaceID：		(NSString *)	placeID
回呼：		(GMSPlaceOpenStatusCallback)	回呼

取得地點的詳細資料，包括目前判斷 GMSPlaceOpenStatus 時所需的所有欄位。

這是非封鎖式方法。

參數：

placeID	要查詢的地點 ID。
回呼	根據地點結果叫用的回呼。

- (void) isOpenWithPlaceID：		(NSString *)	placeID
日期：		(NSDate *)	<日期>
回呼：		(GMSPlaceOpenStatusCallback)	回呼

取得地點的詳細資料，包括在指定 NSDate 中指定 GMSPlaceOpenStatus 所需的所有欄位。

這是非封鎖式方法。

參數：

placeID	要查詢的地點 ID。
日期	用於判斷開放狀態的 NSDate。
回呼	根據地點結果叫用的回呼。

- (void) isOpenWithPlace：		(GMSPlace *)	地點
回呼：		(GMSPlaceOpenStatusCallback)	回呼

取得地點的詳細資料，包括目前判斷 GMSPlaceOpenStatus 時所需的所有欄位。

只有在 GMSPlace 缺少所有必要欄位時，才要求其他欄位，否則，回呼會立即傳回 GMSPlaceOpenStatus。這是非封鎖式方法。

參數：

地點	要查詢的 GMSPlace。
回呼	根據地點結果叫用的回呼。

- (void) isOpenWithPlace：		(GMSPlace *)	地點
日期：		(NSDate *)	<日期>
回呼：		(GMSPlaceOpenStatusCallback)	回呼

取得地點的詳細資料，包括在指定 NSDate 中指定 GMSPlaceOpenStatus 所需的所有欄位。

只有在 GMSPlace 缺少所有必要欄位時，才要求其他欄位，否則，回呼會立即傳回 GMSPlaceOpenStatus。這是非封鎖式方法。

參數：

地點	要查詢的 GMSPlace。
日期	用於判斷開放狀態的 NSDate。
回呼	根據地點結果叫用的回呼。

- (void) searchByTextWithRequest：		(GMSPlaceSearchByTextRequest *)	textSearchRequest
回呼：		(GMSPlaceSearchByTextResultCallback)	回呼

依文字和限制搜尋地點。

這是非封鎖式方法。

參數：

textSearchRequest	GMSPlaceSearchByTextRequest 用於查詢的文字要求。
回呼	對查詢結果叫用的回呼。

---

好友與相關職務說明文件

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

接收 Place Details 查詢的回呼類型。

如果發生錯誤，result 會傳回 nil，且 error 會包含該錯誤的相關資訊。

參數：

結果	傳回的 GMSPlace。
錯誤	發生的錯誤 (如果有的話)。

- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_Nullable 可能 abilityList, NSError *_Nullable error)) [related]

用於接收地點可能性清單的回呼類型。

如果發生錯誤，likelihoodList 會傳回 nil，且 error 會包含該錯誤的相關資訊。

參數：

likelihoodList	地點可能性清單。
錯誤	發生的錯誤 (如果有的話)。

- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullable 可能 s, NSError *_Nullable error)) [related]

用於接收 GMSPlaceLikelihood 陣列的回呼類型。

如果發生錯誤，陣列會是 nil，且 error 會包含錯誤相關資訊。

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

用於接收地點營業時間狀態的回呼類型。

如果發生錯誤，result 會是 GMSPlaceOpenStatusUnknown，error 會包含錯誤的相關資訊。

參數：

結果	傳回的 GMSPlaceOpenStatus。
錯誤	發生的錯誤 (如果有的話)。

- (typedef void(^ GMSPlaceSearchByTextResultCallback)(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)) [related]

用於接收文字搜尋結果搜尋結果的回呼類型。

results 是一個 GMSPlace 陣列，代表符合查詢的個別結果。

參數：

結果	GMSPlace 的陣列。
錯誤	發生的錯誤 (如果有的話)。