סימוכין למחלקה GMSPlaceSearchNearbyRequest

הפניה לכיתה GMSPlaceSearchNearbyRequest

סקירה כללית

בקשת אובייקט לשימוש עם GMSPlacesClient כדי לאחזר מקומות בקרבת מקום.

פונקציות חברים ציבוריים

(instancetype)initWithLocationRestriction:placeProperties:
 יוצרת GMSPlaceSearchNearbyRequest עם הגבלת מיקום ומציבה מאפיינים להחזרה.

מאפיינים

id< GMSPlaceLocationRestriction >locationRestriction
 אתחול ברירת המחדל לא זמין.
NSArray&lt; GMSPlaceProperty > *placeProperties
 המערך של GMSPlaceProperty שצריך להיכלל בתוצאות של מקומות.
NSArray&lt; NSString * > *includedTypes
 מערך סוגי המקומות שיש לכלול בחיפוש.
NSArray&lt; NSString * > *excludedTypes
 המערך של סוגי המקומות שיוחרגו מחיפוש.
NSArray&lt; NSString * > *includedPrimaryTypes
 המערך של סוגי המקומות הראשיים שיש לכלול בחיפוש.
NSArray&lt; NSString * > *excludedPrimaryTypes
 מערך סוגי המקומות הראשיים שיוחרגו מחיפוש.
NSIntegermaxResultCount
 המספר המקסימלי של GMSPlace תוצאות שיחזרו.
NSString *regionCode
 קוד המדינה או האזור ב-Unicode (CLDR) של המיקום שממנו הבקשה מגיעה.
GMSPlaceSearchNearbyRankPreferencerankPreference
 השדה GMSPlaceSearchNearbyRankPreference משמש למיון התוצאות שהוחזרו מהבקשה.

מסמכי תיעוד בנושא פונקציות של חברים

- (instancetype) initWithLocationRestriction: (id< GMSPlaceLocationRestriction >) locationRestriction
placeProperties: (NSArray< GMSPlaceProperty > *) placeProperties

יוצרת GMSPlaceSearchNearbyRequest עם הגבלת מיקום ומציבה מאפיינים להחזרה.

פרמטרים:
locationRestrictionהאזור לחיפוש מצוין כעיגול, מוגדר לפי נקודת המרכז והרדיוס במטרים.
placePropertiesהמערך של GMSPlaceProperty שצריך להיכלל בתוצאות של מקומות. השדה לא יכול להישאר ריק. רשימה ריקה תגרום לשגיאה בניסיון לשלוח את הבקשה.

תיעוד של נכס

- (id<GMSPlaceLocationRestriction>) locationRestriction [read, write, copy]

אתחול ברירת המחדל לא זמין.

צריך להשתמש במאתחל הייעודי. האזור לחיפוש מצוין כעיגול, מוגדר לפי נקודת המרכז והרדיוס במטרים. הרדיוס חייב להיות בין 0.0 ל-50000.0, כולל. הפרת ההגבלה הזו תגרום לשגיאה INVALID_ARGUMENT. צריך לציין את הגבלת המיקום כך: GMSPlaceCircularLocationOption. שימוש ב-GMSPlaceRectangularLocationOption יגרום לשגיאת INVALID_REQUEST.

- (NSArray<GMSPlaceProperty>*) placeProperties [read, write, copy] (

המערך של GMSPlaceProperty שצריך להיכלל בתוצאות של מקומות.

השדה לא יכול להישאר ריק. רשימה ריקה תגרום לשגיאה בניסיון לשלוח את הבקשה.

- (NSArray<NSString *>*) includedTypes [read, write, copy]

מערך סוגי המקומות שיש לכלול בחיפוש.

אפשר לציין עד 50 סוגים. אם בקשה מצוינת עם מספר הגבלות סוגים, יוחזרו רק מקומות שעומדים בכל ההגבלות. אם המערך ריק, יוחזרו כל המקומות מכל הסוגים. בטבלה א' מופיעה רשימת הסוגים הנתמכים: https://developers.google.com/maps/documentation/places/web-service/place-types#table-a.

- (NSArray<NSString *>*) excludedTypes [read, write, copy]

המערך של סוגי המקומות שיוחרגו מהחיפוש.

אפשר לציין עד 50 סוגים. אם בקשה מצוינת עם מספר הגבלות סוגים, יוחזרו רק מקומות שעומדים בכל ההגבלות. אם יצוינו סוגים מתנגשים (למשל, סוגים שמופיעים ב-includeTypes וב-excludedTypes), תוחזר שגיאת INVALID_REQUEST. בטבלה א' מופיעה רשימת הסוגים הנתמכים: https://developers.google.com/maps/documentation/places/web-service/place-types#table-a.

- (NSArray<NSString *>*) includedPrimaryTypes [read, write, copy]

המערך של סוגי המקומות הראשיים שיש לכלול בחיפוש.

אפשר לציין עד 50 סוגים. אם בקשה מצוינת עם מספר הגבלות סוגים, יוחזרו רק מקומות שעומדים בכל ההגבלות. מידע נוסף על סוגים ראשיים זמין בכתובת https://developers.google.com/maps/documentation/places/web-service/nearby-search#includedtypesexcludedtypes,-includedprimarytypesexcludedprimarytypes.

- (NSArray<NSString *>*) excludedPrimaryTypes [read, write, copy]

מערך סוגי המקומות הראשיים שיוחרגו מחיפוש.

אם יצוינו סוגים מתנגשים (למשל, סוגים שמופיעים ב-includeTypes וב-excludedTypes), תוחזר שגיאת INVALID_REQUEST. אפשר לציין עד 50 סוגים. אם בקשה מצוינת עם מספר הגבלות סוגים, יוחזרו רק מקומות שעומדים בכל ההגבלות. מידע נוסף על סוגים ראשיים זמין בכתובת https://developers.google.com/maps/documentation/places/web-service/nearby-search#includedtypesexcludedtypes,-includedprimarytypesexcludedprimarytypes.

- (NSInteger) maxResultCount [read, write, assign]

המספר המקסימלי של GMSPlace תוצאות שיחזרו.

חייב להיות בין 1 ל-20 (ברירת מחדל) כולל. אם תפרו את ההגבלה, תוחזר שגיאה.

- (NSString*) regionCode [read, write, copy]

קוד המדינה או האזור ב-Unicode (CLDR) של המיקום שממנו הבקשה מגיעה.

קודי אזורים זמינים בכתובת https://www.unicode.org/cldr/charts/44/supplemental/territory_language_information.html.

- (GMSPlaceSearchNearbyRankPreference) rankPreference [read, write, assign]

השדה GMSPlaceSearchNearbyRankPreference משמש למיון התוצאות שהוחזרו מהבקשה.

ערך ברירת המחדל הוא GMSPlaceSearchNearbyRankPopularity.