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

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

פונקציות של חברי מועדון

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

נכסים

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

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

- (instancetype) initWithLocationRestriction: (id< GMSPlaceLocationRestriction >) locationRestriction
מאפייני המקום: (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.