ข้อมูลอ้างอิงคลาส 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:
 ดูรายละเอียดของสถานที่รวมถึงช่องทั้งหมดที่จําเป็นต่อการระบุ GMSPlaceOpenStatus ใน NSDate ที่ระบุ
(void) - isOpenWithPlace:callback:
 ดูรายละเอียดของสถานที่รวมถึงช่องทั้งหมดที่จําเป็นต่อการระบุ GMSPlaceOpenStatus ในขณะนั้น
(void) - isOpenWithPlace:date:callback:
 ดูรายละเอียดของสถานที่รวมถึงช่องทั้งหมดที่จําเป็นต่อการระบุ GMSPlaceOpenStatus ใน NSDate ที่ระบุ

ฟังก์ชันสมาชิกสาธารณะแบบคงที่

(ประเภทอินสแตนซ์)+ sharedClient
 ให้อินสแตนซ์ที่ใช้ร่วมกันของ GMSPlacesClient สำหรับ Google Places SDK สำหรับ iOS โดยสร้างอินสแตนซ์ดังกล่าวหากจำเป็น
(BOOL) + provideAPIKey:
 ให้คีย์ API ของคุณแก่ Google Places SDK สำหรับ iOS
(NSString *)+ openSourceLicenseInfo
 ส่งคืนข้อมูลใบอนุญาตซอฟต์แวร์โอเพนซอร์สสำหรับ Google Places SDK สำหรับ iOS
(NSString *)+ SDKVersion
 แสดงเวอร์ชันของ Google Places SDK สำหรับ iOS รุ่นนี้
(NSString *)+ SDKLongVersion
 แสดงเวอร์ชันยาวสำหรับ Google Places SDK สำหรับ iOS รุ่นนี้

(โปรดทราบว่าฟังก์ชันเหล่านี้ไม่ใช่ฟังก์ชันสมาชิก)

typedef void(^ GMSPlaceResultCallback )(GMSPlace *_ผลลัพธ์ที่เป็น Nullable, NSError *_Nullable error)
 ประเภทการติดต่อกลับสำหรับการรับการค้นหารายละเอียดสถานที่
typedef void(^ GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_Nullable opportunitiesList, NSError *_Nullable error)
 ประเภทการติดต่อกลับสำหรับการรับรายการแนวโน้มเกี่ยวกับสถานที่
typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullableแนบไฟล์, NSError *_Nullable error)
 ประเภทโค้ดเรียกกลับสำหรับอาร์เรย์รับของ GMSPlaceLikelihood
typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable results, NSError *_Nullable error)
 ประเภทการติดต่อกลับสำหรับการรับผลการเติมข้อความอัตโนมัติ
typedef void(^ GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_รูปภาพที่ไม่มีข้อมูลได้, NSError *_Nullable error)
 ประเภทการติดต่อกลับสำหรับการรับผลการค้นหารูปภาพสถานที่
typedef void(^ GMSPlacePhotoImageResultCallback )(UIImage *_รูปภาพ Nullable, NSError *_Nullable error)
 ประเภทโค้ดเรียกกลับสำหรับการรับออบเจ็กต์ UIImage จากออบเจ็กต์ GMSPlacePhotoMetadata
typedef void(^ GMSPlaceOpenStatusCallback )(ผลลัพธ์ GMSPlaceOpenStatus, NSError *_Nullable error)
 ประเภทการติดต่อกลับสำหรับการรับสถานะเวลาทำการของสถานที่

เอกสารประกอบเกี่ยวกับฟังก์ชันสมาชิก

+ (จำนวนอินสแตนซ์) sharedClient

ให้อินสแตนซ์ที่ใช้ร่วมกันของ GMSPlacesClient สำหรับ Google Places SDK สำหรับ iOS โดยสร้างอินสแตนซ์ดังกล่าวหากจำเป็น

หากแอปพลิเคชันของคุณมักจะใช้วิธีการของ GMSPlacesClient แอปพลิเคชันอาจต้องยึดออบเจ็กต์นี้โดยตรง มิฉะนั้นการเชื่อมต่อกับ Google อาจรีสตาร์ทเป็นประจำ

+ (BOOL) provideAPIKey: (NSString *) คีย์

ให้คีย์ API ของคุณแก่ Google Places SDK สำหรับ iOS

คีย์นี้สร้างขึ้นสำหรับแอปพลิเคชันของคุณผ่านคอนโซล Google Cloud Platform และจับคู่กับรหัสชุดของแอปพลิเคชันเพื่อระบุคีย์ แอปพลิเคชันของคุณจะเรียกใช้ข้อมูลนี้ก่อนใช้ GMSPlacesClient (เช่น ใน application:didFinishLaunchingWithOptions:)

ส่งกลับ:
ใช่ หากระบุ APIKey เรียบร้อยแล้ว
+ (NSString *) openSourceLicenseInfo

ส่งคืนข้อมูลใบอนุญาตซอฟต์แวร์โอเพนซอร์สสำหรับ Google Places SDK สำหรับ iOS

ข้อมูลนี้จะต้องปรากฏภายในใบสมัครของคุณ

+ (NSString *) SDKVersion

แสดงเวอร์ชันของ Google Places SDK สำหรับ iOS รุ่นนี้

เช่น "1.0.0"

+ (NSString *) SDKLongVersion

แสดงเวอร์ชันยาวสำหรับ Google Places SDK สำหรับ iOS รุ่นนี้

เช่น "1.0.0 (102.1)"

- (เป็นโมฆะ) lookUpPlaceID: (NSString *) placeID
โค้ดเรียกกลับ: (GMSPlaceResultCallback) โทรกลับ

ดูรายละเอียดของสถานที่

วิธีนี้ไม่ได้บล็อกการทำงาน

พารามิเตอร์:
placeIDรหัสสถานที่ที่จะค้นหา
โค้ดเรียกกลับการเรียกกลับที่จะเรียกกับผลการค้นหา
- (เป็นโมฆะ) searchUpPhotosForPlaceID: (NSString *) placeID
โค้ดเรียกกลับ: (GMSPlacePhotoMetadataResultCallback) โทรกลับ

รับข้อมูลเมตาสำหรับรูปภาพสูงสุด 10 รูปที่เชื่อมโยงกับสถานที่

รูปภาพมาจากหลากหลายสถานที่ รวมถึงเจ้าของธุรกิจและรูปภาพจากผู้ใช้ Google+ ในกรณีส่วนใหญ่ รูปภาพเหล่านี้จะใช้ได้โดยไม่ต้องแสดงที่มา หรือจะมีแอตทริบิวต์ที่จำเป็นรวมอยู่ในรูปภาพด้วย อย่างไรก็ตาม คุณต้องใช้พร็อพเพอร์ตี้ attributions ในการตอบกลับเพื่อเรียกข้อมูลการระบุแหล่งที่มาเพิ่มเติมที่จำเป็น และแสดงการระบุแหล่งที่มาเหล่านั้นในแอปพลิเคชันของคุณในตำแหน่งใดก็ตามที่คุณแสดงรูปภาพ โดยจะส่งคืนรูปภาพได้สูงสุด 10 รูป

การเรียกวิธีนี้หลายครั้งอาจแสดงรูปภาพเดียวกันในแต่ละครั้ง แต่เราไม่รับประกันเนื่องจากข้อมูลพื้นฐานอาจมีการเปลี่ยนแปลง

วิธีนี้จะทำการค้นหาเครือข่าย

พารามิเตอร์:
placeIDรหัสสถานที่ที่จะค้นหารูปภาพ
โค้ดเรียกกลับการเรียกกลับที่จะเรียกกับผลการค้นหา
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata
โค้ดเรียกกลับ: (GMSPlacePhotoImageResultCallback) โทรกลับ

โหลดรูปภาพของบางรูปในขนาดสูงสุด

SDK อาจแคชข้อมูลรูปภาพไว้ ถ้ารูปภาพที่ต้องการไม่อยู่ในแคช ระบบจะดำเนินการค้นหาเครือข่าย

พารามิเตอร์:
photoMetadataGMSPlacePhotoMetadata ที่จะโหลด UIImage
โค้ดเรียกกลับโค้ดเรียกกลับที่จะเรียกใช้ด้วย UIImage ที่โหลด
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata
ข้อจำกัดด้านขนาด: (CGSize) maxSize
มาตราส่วน: (CGFloat) มาตราส่วน
โค้ดเรียกกลับ: (GMSPlacePhotoImageResultCallback) โทรกลับ

โหลดรูปภาพของบางภาพ โดยปรับขนาดให้พอดีกับขนาดสูงสุดที่กำหนด

รูปภาพจะได้รับการปรับขนาดให้พอดีกับขนาดที่ระบุ ในขณะที่ยังคงรักษาอัตราส่วนของรูปภาพต้นฉบับไว้ การปรับขนาดนี้จะทำฝั่งเซิร์ฟเวอร์

หากพารามิเตอร์การปรับขนาดไม่ใช่ 1.0 maxSize ระบบจะคูณด้วยค่านี้ และ UIImage ที่แสดงผลจะได้รับการตั้งค่าเป็นสเกลที่ระบุ ควรตั้งค่าพารามิเตอร์นี้เป็นสเกลหน้าจอหากคุณกำลังโหลดรูปภาพเพื่อแสดงบนหน้าจอ

SDK อาจแคชข้อมูลรูปภาพไว้ ถ้ารูปภาพที่ต้องการไม่อยู่ในแคช ระบบจะดำเนินการค้นหาเครือข่าย

หมายเหตุ
หลังจากใช้ตัวคูณมาตราส่วนแล้ว ระบบจะปัดเศษขนาดใน maxSize ขึ้นเป็นจำนวนเต็มที่ใกล้ที่สุดก่อนใช้งาน หากมีการขอรูปภาพที่มีขนาดใหญ่กว่าขนาดสูงสุดที่ใช้ได้ ระบบอาจส่งคืนรูปภาพที่เล็กลง
พารามิเตอร์:
photoMetadataGMSPlacePhotoMetadata ที่จะโหลด UIImage
maxSizeขนาดสูงสุดของรูปภาพ
มาตราส่วนขนาดที่ใช้โหลดรูปภาพ
โค้ดเรียกกลับโค้ดเรียกกลับที่จะเรียกใช้ด้วย UIImage ที่โหลด
- (โมฆะ) currentPlaceWithCallback: (GMSPlaceLikelihoodListCallback) ติดต่อกลับ

แสดงผลค่าประมาณสถานที่ที่ทราบว่าอุปกรณ์ตั้งอยู่

สร้างรายการแนวโน้มเกี่ยวกับสถานที่ตามตำแหน่งโดยประมาณล่าสุดของอุปกรณ์ ระบบจะเรียกใช้โค้ดเรียกกลับที่ระบุกับรายการแนวโน้มนี้เมื่อสำเร็จ และ NSError เมื่อเกิดข้อผิดพลาด

หมายเหตุ
วิธีนี้กำหนดให้แอปของคุณต้องมีสิทธิ์เข้าถึงตำแหน่งปัจจุบันของอุปกรณ์ ก่อนเรียกใช้รายการนี้ โปรดขอสิทธิ์เข้าถึงตำแหน่งของผู้ใช้โดยใช้ [CLLocationManager requestWhenInUseAuthorization] หรือ [CLLocationManager request alwaysAuthorization] หากคุณเรียกใช้เมธอดนี้แล้วแอปมีสถานะการให้สิทธิ์ไม่ถูกต้อง ระบบจะเรียกใช้โค้ดเรียกกลับแต่มีข้อผิดพลาด
พารามิเตอร์:
โค้ดเรียกกลับการเรียกกลับที่จะเรียกกับรายการแนวโน้มสถานที่
- (void) findAutocompletePredictionsFromQuery: (NSString *) คำค้นหา
ตัวกรอง: (GMSAutocompleteFilter เป็นค่าว่าง *) ตัวกรอง
sessionToken: (GMSAutocompleteSessionToken ว่างเปล่า *) sessionToken
โค้ดเรียกกลับ: (GMSAutocompletePredictionsCallback) โทรกลับ

ค้นหาการคาดคะเนการเติมข้อความอัตโนมัติจากข้อความค้นหา

ผลการค้นหาอาจมีความเอนเอียงในตำแหน่งที่ตั้งบางแห่งหรือถูกจำกัดไว้ในพื้นที่ใดพื้นที่หนึ่ง วิธีนี้ไม่ได้บล็อกการทำงาน

โค้ดเรียกกลับที่ระบุจะมีการเรียกใช้พร้อมกับอาร์เรย์ของการคาดคะเนการเติมข้อความอัตโนมัติเมื่อเสร็จสมบูรณ์ และ NSError เมื่อมีข้อผิดพลาด

พารามิเตอร์:
queryข้อความบางส่วนที่จะเติมข้อความอัตโนมัติ
ฟิลเตอร์ตัวกรองที่จะนำไปใช้กับผลการค้นหา พารามิเตอร์นี้อาจเป็นค่าว่าง
sessionTokenGMSAutocompleteSessionToken ที่จะเชื่อมโยงคำขอกับเซสชันการเรียกเก็บเงิน
โค้ดเรียกกลับโค้ดเรียกกลับที่จะเรียกใช้กับการคาดการณ์
- (void) fetchPlaceFromPlaceID: (NSString *) placeID
ฟิลด์สถานที่: (GMSPlaceField) placeFields
sessionToken: (GMSAutocompleteSessionToken ว่างเปล่า *) sessionToken
โค้ดเรียกกลับ: (GMSPlaceResultCallback) โทรกลับ

เรียกรายละเอียดของสถานที่

วิธีนี้ไม่ได้บล็อกการทำงาน

พารามิเตอร์:
placeIDรหัสสถานที่ที่จะค้นหา
placeFieldsช่องสถานที่แต่ละช่องที่ขอสำหรับออบเจ็กต์สถานที่ในรายการ
sessionTokenGMSAutocompleteSessionToken ที่จะเชื่อมโยงคำขอกับเซสชันการเรียกเก็บเงิน
โค้ดเรียกกลับการเรียกกลับที่จะเรียกกับผลการค้นหา
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: (GMSPlaceField) placeFields
โค้ดเรียกกลับ: (GMSPlaceLikelihoodsCallback) โทรกลับ

หาแนวโน้มของสถานที่โดยใช้ตำแหน่งปัจจุบันของผู้ใช้

วิธีนี้ไม่ได้บล็อกการทำงาน

ระบบจะเรียกใช้โค้ดเรียกกลับที่ระบุกับอาร์เรย์ของตำแหน่งที่มีคะแนนแนวโน้มสำเร็จ และ NSError เมื่อเกิดข้อผิดพลาด

พารามิเตอร์:
placeFieldsช่องสถานที่แต่ละช่องที่ขอสำหรับออบเจ็กต์สถานที่ในรายการ
โค้ดเรียกกลับการเรียกกลับที่จะเรียกใช้ด้วยแนวโน้มสถานที่
- (เป็นโมฆะ) isOpenWithPlaceID: (NSString *) placeID
โค้ดเรียกกลับ: (GMSPlaceOpenStatusCallback) โทรกลับ

ดูรายละเอียดของสถานที่รวมถึงช่องทั้งหมดที่จําเป็นต่อการระบุ GMSPlaceOpenStatus ในขณะนั้น

วิธีนี้ไม่ได้บล็อกการทำงาน

พารามิเตอร์:
placeIDรหัสสถานที่ที่จะค้นหา
โค้ดเรียกกลับโค้ดเรียกกลับที่จะเรียกใช้กับผลลัพธ์สถานที่
- (เป็นโมฆะ) isOpenWithPlaceID: (NSString *) placeID
วันที่: (NSDate *) วันที่
โค้ดเรียกกลับ: (GMSPlaceOpenStatusCallback) โทรกลับ

ดูรายละเอียดของสถานที่รวมถึงช่องทั้งหมดที่จําเป็นต่อการระบุ GMSPlaceOpenStatus ใน NSDate ที่ระบุ

วิธีนี้ไม่ได้บล็อกการทำงาน

พารามิเตอร์:
placeIDรหัสสถานที่ที่จะค้นหา
วันที่NSDate ที่กําหนดสถานะเปิดอยู่
โค้ดเรียกกลับโค้ดเรียกกลับที่จะเรียกใช้กับผลลัพธ์สถานที่
- (void) isOpenWithPlace: (GMSPlace *) สถานที่
โค้ดเรียกกลับ: (GMSPlaceOpenStatusCallback) โทรกลับ

ดูรายละเอียดของสถานที่รวมถึงช่องทั้งหมดที่จําเป็นต่อการระบุ GMSPlaceOpenStatus ในขณะนั้น

ขอเฉพาะช่องเพิ่มเติมหาก GMSPlace ไม่มีช่องที่จำเป็นทั้งหมด มิเช่นนั้นระบบจะแสดงผล GMSPlaceOpenStatus ในโค้ดเรียกกลับทันที วิธีนี้ไม่ได้บล็อกการทำงาน

พารามิเตอร์:
สถานที่GMSPlace ที่จะค้นหา
โค้ดเรียกกลับโค้ดเรียกกลับที่จะเรียกใช้กับผลลัพธ์สถานที่
- (void) isOpenWithPlace: (GMSPlace *) สถานที่
วันที่: (NSDate *) วันที่
โค้ดเรียกกลับ: (GMSPlaceOpenStatusCallback) โทรกลับ

ดูรายละเอียดของสถานที่รวมถึงช่องทั้งหมดที่จําเป็นต่อการระบุ GMSPlaceOpenStatus ใน NSDate ที่ระบุ

ขอเฉพาะช่องเพิ่มเติมหาก 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, NSError *_Nullable error)) [related]

ประเภทการติดต่อกลับสำหรับการรับการค้นหารายละเอียดสถานที่

หากเกิดข้อผิดพลาด result จะเป็น nil และ error จะมีข้อมูลเกี่ยวกับข้อผิดพลาด

พารามิเตอร์:
ผลลัพธ์GMSPlace ที่ส่งคืน
errorข้อผิดพลาดที่เกิดขึ้น (หากมี)
- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_NullabledemandList, NSError *_Nullable error)) [related]

ประเภทการติดต่อกลับสำหรับการรับรายการแนวโน้มเกี่ยวกับสถานที่

หากเกิดข้อผิดพลาด likelihoodList จะเป็น nil และ error จะมีข้อมูลเกี่ยวกับข้อผิดพลาด

พารามิเตอร์:
likelihoodListรายการแนวโน้มของสถานที่
errorข้อผิดพลาดที่เกิดขึ้น (หากมี)
- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullable opportunities, 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, NSError *_Nullable error)) [related]

ประเภทการติดต่อกลับสำหรับการรับผลการค้นหารูปภาพสถานที่

หากเกิดข้อผิดพลาด photos จะเป็น nil และ error จะมีข้อมูลเกี่ยวกับข้อผิดพลาด

พารามิเตอร์:
ภาพถ่ายผลลัพธ์มีออบเจ็กต์ GMSPlacePhotoMetadata รายการ
errorข้อผิดพลาดที่เกิดขึ้น (หากมี)
- (typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_รูปภาพ Nullable, NSError *_Nullable error)) [related]

ประเภทโค้ดเรียกกลับสำหรับการรับออบเจ็กต์ UIImage จากออบเจ็กต์ GMSPlacePhotoMetadata

หากเกิดข้อผิดพลาด photo จะเป็น nil และ error จะมีข้อมูลเกี่ยวกับข้อผิดพลาด

พารามิเตอร์:
รูปภาพUIImage ที่โหลด
errorข้อผิดพลาดที่เกิดขึ้น (หากมี)
- (typedef void(^ GMSPlaceOpenStatusCallback)(ผลลัพธ์ GMSPlaceOpenStatus, NSError *_Nullable error)) [related]

ประเภทการติดต่อกลับสำหรับการรับสถานะเวลาทำการของสถานที่

หากเกิดข้อผิดพลาดขึ้น result จะเป็น GMSPlaceOpenStatusUnknown และ error จะมีข้อมูลเกี่ยวกับข้อผิดพลาดนั้น

พารามิเตอร์:
ผลลัพธ์GMSPlaceOpenStatus ที่ส่งคืน
errorข้อผิดพลาดที่เกิดขึ้น (หากมี)