Method: geocode.destinations.searchDestinations

השיטה הזו מבצעת חיפוש של יעדים ומחזירה רשימה של יעדים.

בקשת HTTP

POST https://geocode.googleapis.com/v4alpha/geocode/destinations

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "travelModes": [
    enum (NavigationPoint.TravelMode)
  ],
  "languageCode": string,
  "regionCode": string,

  // Union field primary_query can be only one of the following:
  "place": string,
  "addressQuery": {
    object (SearchDestinationsRequest.AddressQuery)
  },
  "locationQuery": {
    object (SearchDestinationsRequest.LocationQuery)
  }
  // End of list of possible types for union field primary_query.
}
שדות
travelModes[]

enum (NavigationPoint.TravelMode)

אופציונלי. אמצעי התחבורה שלפיהם רוצים לסנן את נקודות הניווט. הפעולה הזו משפיעה על השדה navigationPoints שמוחזר בתגובה. אם השדה ריק, מוחזרות נקודות ניווט של כל אמצעי התחבורה.
languageCode

string

אופציונלי. השפה שצריך להחזיר בה את התוצאות.
regionCode

string

אופציונלי. קוד אזור. קוד האזור, שמוגדר כערך ccTLD (דומיין ברמה העליונה) באורך שני תווים. הפרמטר משפיע על התוצאות בהתאם לדין החל. הפרמטר הזה ישפיע גם על התוצאות מהשירות, אבל לא יגביל אותן באופן מלא.

שדה של איחוד primary_query. שליחת שאילתה ליעד הראשי. המיקום יכול להיות מקום, כתובת מלאה או מיקום LatLng. לא ניתן להפוך ליעד מקומות וכתובות עם מידע מינימלי.

היעדים מבוססים על השאילתה הראשית שצוינה.

הערה: אפשר להוסיף רק מקומות וכתובות שיכולים להיות יעד לניווט. לדוגמה, אפשר להשתמש במקום שמייצג בית או מתחם דירות כשאילתה ראשית, אבל אי אפשר להשתמש במקומות שמייצגים רשות מוניציפאלית או אזור מנהלי כשאילתה ראשית. הערך primary_query יכול להיות רק אחד מהבאים:
place

string

שם המשאב של המקום, בפורמט places/{placeId}.
addressQuery

object (SearchDestinationsRequest.AddressQuery)

כתובת.
locationQuery

object (SearchDestinationsRequest.LocationQuery)

מיקום מדויק.

גוף התשובה

הודעת תגובה ל-DestinationService.SearchDestinations.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "destinations": [
    {
      object (Destination)
    }
  ]
}
שדות
destinations[]

object (Destination)

רשימה של יעדים.

השירות מחזיר תוצאה אחת אם אפשר לזהות באופן חד-משמעי יעד ראשי מהשאילתה הראשית. אחרת, יכול להיות שהשירות יחזיר כמה תוצאות להפגת עמימות או אפס תוצאות.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.destinations

SearchDestinationsRequest.AddressQuery

הכתובת שרוצים לחפש. צריך לציין כתובות בהתאם לפורמט שבו משתמש שירות הדואר הלאומי של המדינה הרלוונטית.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "address": {
    object (PostalAddress)
  },
  "addressQuery": string
  // End of list of possible types for union field kind.
}
שדות
שדה של איחוד kind. השאילתה של הכתובת. הערך kind יכול להיות רק אחד מהבאים:
address

object (PostalAddress)

כתובת רחוב בפורמט של כתובת למשלוח דואר.
addressQuery

string

כתובת רחוב בפורמט של שורה אחת.

SearchDestinationsRequest.LocationQuery

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

הערה: אם שאילתת המיקום היא בתוך בניין שמכיל משנה-מבנים, יכול להיות שהמקום הראשי שיוחזר הוא משנה-מבנה. במקרים כאלה, השדה containingPlaces יכלול את הבניין.

ייצוג ב-JSON 
{
  "placeFilter": {
    object (SearchDestinationsRequest.LocationQuery.PlaceFilter)
  },

  // Union field kind can be only one of the following:
  "location": {
    object (LatLng)
  }
  // End of list of possible types for union field kind.
}
שדות
placeFilter

object (SearchDestinationsRequest.LocationQuery.PlaceFilter)

אופציונלי. מסננים שצריך להחיל על יעדים מועמדים.
שדה איחוד kind. שאילתת המיקום. הערך kind יכול להיות רק אחד מהבאים:
location

object (LatLng)

מיקום מדויק של קו רוחב וקו אורך.

SearchDestinationsRequest.LocationQuery.PlaceFilter

מסננים שצריך להחיל על יעדים מועמדים.

ייצוג ב-JSON 
{
  "structureType": enum (PlaceView.StructureType),
  "addressability": enum (SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability)
}
שדות
structureType

enum (PlaceView.StructureType)

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

לדוגמה, אם מציינים את הערך GROUNDS, לכל היעדים שיוחזרו יהיה מקום ראשי עם סוג המבנה GROUNDS. כתוצאה מכך, יכול להיות שהמערכת תסנן יעדים שלא נמצאים במתחם, או תציג את היעדים שהוחזרו ברמת המתחם.

שימוש נוסף בשדה הזה הוא כדי לחלץ בקלות רבה יותר מצולעים של בניינים. לדוגמה, אם מציינים את BUILDING, מצולע התצוגה של המקום הראשי יהיה של הבניין במיקום שצוין.
addressability

enum (SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability)

אופציונלי. אם מציינים את הפרמטר הזה, המערכת מחזירה רק יעדים שעומדים בקריטריונים המתאימים של יכולת הדיוור.

PlaceView.StructureType

סוג המבנה שהמקום הזה מייצג.

טיפוסים בני מנייה (enum)
STRUCTURE_TYPE_UNSPECIFIED לא בשימוש.
POINT מיקום נקודתי.
SECTION חלק משני של בניין.
BUILDING בניין.
GROUNDS אזור גדול שבדרך כלל מכיל כמה מבנים, כמו קמפוס של אוניברסיטה, מתחם דירות או קניון.

SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability

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

טיפוסים בני מנייה (enum)
ADDRESSABILITY_UNSPECIFIED אם לא מציינים ברירת מחדל, השירות יבחר ברירת מחדל הגיונית.
ANY היכולת להציג מודעות לאנשים מסוימים היא לא קריטריון לסינון. היעדים מוחזרים ללא קשר לכתובת שלהם.
PRIMARY כל היעדים שיוחזרו יכללו מקום ראשי עם כתובת או שם ברמת הרחוב.
WEAK כל היעדים שיוחזרו יכללו מקום ראשי או יעד משני עם כתובת או שם ברמת הרחוב.

יעד

יעד. הנתונים האלה כוללים את המקום הראשי, מקומות קשורים, כניסות ונקודות ניווט.

ייצוג ב-JSON 
{
  "primary": {
    object (PlaceView)
  },
  "containingPlaces": [
    {
      object (PlaceView)
    }
  ],
  "subDestinations": [
    {
      object (PlaceView)
    }
  ],
  "landmarks": [
    {
      object (Landmark)
    }
  ],
  "entrances": [
    {
      object (Entrance)
    }
  ],
  "navigationPoints": [
    {
      object (NavigationPoint)
    }
  ],
  "parkingOptions": {
    object (Destination.ParkingOptions)
  },
  "arrivalSummary": {
    object (Destination.ArrivalSummary)
  }
}
שדות
primary

object (PlaceView)

המקום הראשי שזוהה על ידי primary_query בבקשה.
containingPlaces[]

object (PlaceView)

המקומות הפחות מדויקים שהמקום הראשי נמצא בתוכם. לדוגמה, מתחם הדירות שבו נמצא הבניין הזה.
subDestinations[]

object (PlaceView)

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

הערה: בהשוואה ל-SubDestination שמוחזר על ידי Places API, רשימת יעדי המשנה הזו מקיפה יותר, וכל יעד משנה מכיל מידע נוסף.
landmarks[]

object (Landmark)

ציוני דרך שאפשר להשתמש בהם כדי לציין איפה היעד נמצא או כדי לעזור להגיע אליו.
entrances[]

object (Entrance)

כניסות ליעד הזה.
navigationPoints[]

object (NavigationPoint)

נקודות ניווט ליעד הזה.
parkingOptions

object (Destination.ParkingOptions)

אפשרויות חנייה ביעד הזה.
arrivalSummary

object (Destination.ArrivalSummary)

סיכום שנוצר על ידי AI של חוויית ההגעה ליעד.

PlaceView

מייצג תצוגה של מקום ב-Places API. היא גם מספקת מידע נוסף שספציפי ליעדים, כמו סוג המבנה והמצולע לתצוגה.

במקרים מסוימים, PlaceView עם אותו מזהה מקום עשוי להיות שונה מהערכים שמוחזרים על ידי Places API בשדות types ו-displayName.

ייצוג ב-JSON 
{
  "place": string,
  "displayName": {
    object (LocalizedText)
  },
  "primaryType": string,
  "types": [
    string
  ],
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "structureType": enum (PlaceView.StructureType),
  "location": {
    object (LatLng)
  },
  "displayPolygon": {
    object
  },
  "addressComponents": [
    {
      object (PlaceView.AddressComponent)
    }
  ]
}
שדות
place

string

שם המשאב של המקום הזה, בפורמט places/{placeId}. אפשר להשתמש בו כדי לחפש את המקום.
placeId

string

המזהה הייחודי של המקום.
displayName

object (LocalizedText)

תיאור קריא של המקום. לדוגמה, "שער ב'", "מקדונלדס"
primaryType

string

סוג המקום העיקרי של המקום הזה. רשימת הערכים האפשריים מופיעה בכתובת https://developers.google.com/maps/documentation/places/web-service/place-types.

הערה: השדה הזה לא תמיד מאוכלס. במצבים כאלה, תצטרכו להשתמש בשדה types.
types[]

string

כל סוגי המקומות שמשויכים למקום הזה. רשימת הערכים האפשריים מופיעה בכתובת https://developers.google.com/maps/documentation/places/web-service/place-types.
formattedAddress

string

כתובת בשורה אחת.
postalAddress

object (PostalAddress)

כתובת מובנית.
structureType

enum (PlaceView.StructureType)

סוג המבנה שמתאים למקום הזה.
location

object (LatLng)

המיקום של המקום הזה. במקומות שבהם מוצגים פוליגונים, אפשר להשתמש בהם כדי להציב סמן במפה.
displayPolygon

object (Struct format)

המתאר של המקום בצורת מצולע בפורמט GeoJSON, בפורמט RFC 7946: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6.

הערה: הפורמט RFC 7946 תומך במרובה-פוליגונים, כך שאובייקט displayPolygon אחד יכול לייצג כמה פוליגונים.
addressComponents[]

object (PlaceView.AddressComponent)

רכיבים שחוזרים על עצמם בכל רמה של יישוב.

PlaceView.AddressComponent

הרכיבים המובְנים שמרכיבים את הכתובת בפורמט, אם המידע הזה זמין.

ייצוג ב-JSON 
{
  "longText": string,
  "shortText": string,
  "types": [
    string
  ],
  "languageCode": string
}
שדות
longText

string

התיאור המלא בטקסט או השם של רכיב הכתובת. לדוגמה, רכיב כתובת של המדינה אוסטרליה יכול להיות עם השם הארוך "אוסטרליה".
shortText

string

שם טקסטואלי מקוצר של רכיב הכתובת, אם יש כזה. לדוגמה, לרכיב כתובת של המדינה אוסטרליה יכול להיות השם המקוצר "AU".
types[]

string

מערך שמציין את הסוגים של רכיב הכתובת.

פרטים נוספים זמינים בכתובת https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types.
languageCode

string

השפה שמשמשת לעיצוב הרכיב הזה, בסימון CLDR.

ציון דרך

ציוני דרך משמשים כדי להסביר איפה היעד נמצא או כדי לעזור להגיע אליו.

ייצוג ב-JSON 
{
  "relationalDescription": {
    object (LocalizedText)
  },
  "tags": [
    enum (Landmark.Tag)
  ],
  "straightLineDistanceMeters": number,
  "travelDistanceMeters": number,

  // Union field landmark can be only one of the following:
  "place": {
    object (PlaceView)
  }
  // End of list of possible types for union field landmark.
}
שדות
relationalDescription

object (LocalizedText)

תיאור קריא לאנשים של הקשר בין היעד לבין נקודת הציון. לדוגמה: 'ליד בניין האמפייר סטייט' או 'מול הבית הלבן'.
tags[]

enum (Landmark.Tag)

תגים שמתארים איך אפשר להשתמש בציון הדרך בהקשר של היעד.
straightLineDistanceMeters

number

פלט בלבד. המרחק בקו ישר מנקודת הציון הזו ליעד, במטרים.
travelDistanceMeters

number

פלט בלבד. מרחק ההליכה מנקודת הציון הזו ליעד במטרים.
שדה איחוד landmark. ציון הדרך. הערך landmark יכול להיות רק אחד מהבאים:
place

object (PlaceView)

המקום שמייצג את נקודת הציון הזו.

Landmark.Tag

רשימה של כל התגים האפשריים שמתארים איך אפשר להשתמש בנקודת ציון בהקשר של יעד.

אם לכתובת יש גם את התג ADDRESS וגם את התג ARRIVAL, המשמעות היא שציון הדרך בולט באופן מקומי וקרוב ליעד.

טיפוסים בני מנייה (enum)
TAG_UNSPECIFIED לא בשימוש.
ADDRESS מקום בולט מקומי שאפשר להשתמש בו כדי לזהות את המיקום הכללי של היעד. בדרך כלל במרחק של כמה מאות מטרים מהיעד. הם דומים לנקודות הציון שמוחזרות על ידי התכונה "תיאורי כתובות" של Geocoding API: ‏https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors.
ARRIVAL מקום שיכול לעזור להגיע ליעד. האפשרות הזו שימושית לניווט כשמתקרבים ליעד. לדוגמה, נקודת הציון הזו יכולה להיות מקום שנמצא מעבר לרחוב מהיעד. ציון דרך עם התג הזה בדרך כלל קרוב יותר ליעד מאשר ציוני דרך עם התג ADDRESS.

כניסה

כניסה היא זוג קואורדינטות יחיד של קו רוחב וקו אורך שמגדיר את המיקום של נקודת כניסה ויציאה למקום.

ייצוג ב-JSON 
{
  "location": {
    object (LatLng)
  },
  "tags": [
    enum (Entrance.Tag)
  ],
  "place": string,
  "streetViewThumbnail": {
    object (StreetViewThumbnail)
  },
  "streetViewAnnotation": {
    object (ImageAnnotation)
  }
}
שדות
location

object (LatLng)

המיקום של הכניסה.
tags[]

enum (Entrance.Tag)

רשימת תגים שמתארים את הכניסה.
place

string

המבנה שבו הכניסה הזו ממוקמת פיזית, בפורמט places/{placeId}.
streetViewThumbnail

object (StreetViewThumbnail)

תמונה ממוזערת של Street View שמראה את הכניסה. אפשר לבקש את התמונה מ-Street View Static API. מידע נוסף זמין בכתובת https://developers.google.com/maps/documentation/streetview/request-streetview.
streetViewAnnotation

object (ImageAnnotation)

הערה לגבי הכניסה ב-streetViewThumbnail שמוחזר למעלה.

Entrance.Tag

מאפיינים שמתארים כניסה.

טיפוסים בני מנייה (enum)
TAG_UNSPECIFIED לא בשימוש.
PREFERRED

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

לדוגמה, אם המקום הראשי הוא מסעדה במרכז מסחרי, הכניסות המועדפות (PREFERRED) יהיו אלה שסביר להניח שמובילות למסעדה עצמה, והכניסות האחרות שיוחזרו יהיו כניסות אחרות לבניין, כמו כניסות למסעדות אחרות במרכז המסחרי.

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

הערה: יכול להיות שכניסה PREFERRED לא תספק גישה למקום הראשי, וכניסה שאינה PREFERRED תספק גישה למקום הראשי.

StreetViewThumbnail

פרמטרים לייצוג תמונה ממוזערת של Google Street View. אפשר להשתמש בפרמטרים האלה כדי לבקש תמונת Street View מ-Street View Static API. מידע נוסף זמין בכתובת https://developers.google.com/maps/documentation/streetview/request-streetview.

ייצוג ב-JSON 
{
  "pano": string,
  "widthPx": integer,
  "heightPx": integer,
  "headingDegree": number,
  "pitchDegree": number,
  "fovDegree": number
}
שדות
pano

string

מזהה ספציפי של תמונה פנורמית.
widthPx

integer

רוחב התמונה הממוזערת שנוצרה, בפיקסלים. הערה: כשמבקשים הערות לצד התמונה הממוזערת, צריך להשתמש בערכי הגובה והרוחב האלה בבקשה ל-Street View API כדי לוודא שהקואורדינטות של ההערות תואמות לתמונה.
heightPx

integer

גובה התמונה הממוזערת של הפלט בפיקסלים. הערה: כשמבקשים הערות לצד התמונה הממוזערת, צריך להשתמש בערכי הגובה והרוחב האלה בבקשה ל-Street View API כדי לוודא שהקואורדינטות של ההערות תואמות לתמונה.
headingDegree

number

הכיוון האופקי של המצלמה במעלות. טווח [0, 360). הערך 0 מציין צפון והערך 90 מציין מזרח.
pitchDegree

number

הכיוון האנכי של המצלמה במעלות. טווח [‎-90, 90]. ‫0 הוא האופק, ‎+90 הוא ישר למעלה, ‎-90 הוא ישר למטה.
fovDegree

number

שדה הראייה האופקי במעלות. טווח (0, 180]. שליטה ברמת הזום. שדה ראייה קטן יותר אומר שהזום גדול יותר.

ImageAnnotation

הערה על תמונה ממוזערת, כמו מצולע שמתווה כניסה.

ייצוג ב-JSON 
{
  "coordinates": [
    {
      object (ImageAnnotation.Coordinate)
    }
  ]
}
שדות
coordinates[]

object (ImageAnnotation.Coordinate)

רשימה של קואורדינטות שיוצרות פוליגון בתמונה. הקואורדינטות מסודרות נגד כיוון השעון.

ImageAnnotation.Coordinate

קואורדינטת פיקסל של נקודה בתמונה. נקודת המוצא (0,0) היא הפינה השמאלית העליונה של הפיקסל השמאלי העליון של התמונה, כאשר ציר ה-X פונה ימינה וציר ה-Y פונה כלפי מטה.

ייצוג ב-JSON 
{
  "xPx": number,
  "yPx": number
}
שדות
xPx

number

קואורדינטת X.
yPx

number

קואורדינטת Y.

Destination.ParkingOptions

מידע על אפשרויות החנייה ביעד.

ייצוג ב-JSON 
{
  "availability": enum (Destination.ParkingOptions.Availability),
  "onsiteParking": boolean,
  "freeParkingLot": boolean,
  "paidParkingLot": boolean,
  "freeStreetParking": boolean,
  "paidStreetParking": boolean,
  "valetParking": boolean,
  "freeGarageParking": boolean,
  "paidGarageParking": boolean
}
שדות
availability

enum (Destination.ParkingOptions.Availability)

זמינות החנייה ביעד הזה.
onsiteParking

boolean

יש חנייה במקום היעד.
freeParkingLot

boolean

יש חניונים בחינם.
paidParkingLot

boolean

יש מגרשי חנייה בתשלום.
freeStreetParking

boolean

יש חניה ברחוב בחינם.
paidStreetParking

boolean

יש חנייה ברחוב בתשלום.
valetParking

boolean

יש שירות החניית רכבים.
freeGarageParking

boolean

יש חניון מקורה בחינם.
paidGarageParking

boolean

יש חניון בתשלום.

Destination.ParkingOptions.Availability

מדד מצטבר של הקושי למצוא חניה כשמבקרים במקום הזה.

יכול להיות שבעתיד נוסיף ערכים חדשים.

טיפוסים בני מנייה (enum)
AVAILABILITY_UNSPECIFIED אין מידע על זמינות החנייה.
PLENTY יש הרבה מקומות חניה.
SOMEWHAT_DIFFICULT קצת קשה למצוא חנייה.
DIFFICULT קשה מאוד למצוא חניה.

Destination.ArrivalSummary

סיכום שנוצר על ידי AI של חוויית ההגעה ליעד.

ייצוג ב-JSON 
{
  "text": {
    object (LocalizedText)
  },
  "flagContentUrl": string,
  "disclosureText": {
    object (LocalizedText)
  }
}
שדות
text

object (LocalizedText)

סיכום של חוויית ההגעה ליעד.
flagContentUrl

string

קישור שדרכו משתמשים יכולים לסמן בעיה בסיכום.
disclosureText

object (LocalizedText)

פלט בלבד. מכיל את טקסט הגילוי הנאות של סיכום ההגעה.