Package google.type

אינדקס

LatLng

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

שדות
latitude

double

קו הרוחב במעלות. הערך חייב להיות בטווח [-90.0, +90.0].
longitude

double

קו האורך במעלות. הוא חייב להיות בטווח [-180.0, +180.0].

PostalAddress

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

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

טיפים להזנה או לעריכה של כתובות:

  • להשתמש בווידג'ט כתובות שמותאם לתרגום לשפות שונות, כמו https://github.com/google/libaddressinput.
  • אסור להציג למשתמשים רכיבי ממשק משתמש להזנה או לעריכה של שדות מחוץ למדינות שבהן נעשה שימוש בשדה הזה.

הנחיות נוספות לשימוש בסכימה הזו זמינות בכתובת https://support.google.com/business/answer/6397478.

שדות
revision

int32

גרסת הסכימה של PostalAddress. כל ערך שאינו 0 יגרום ל-API להחזיר שגיאה מסוג INVALID_ARGUMENT.
region_code

string

אופציונלי. קוד האזור במאגר CLDR של המדינה או האזור של הכתובת. פרטים נוספים זמינים בכתובות https://cldr.unicode.org/ ו-https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. דוגמה: 'CH' לשווייץ. אם לא מציינים את קוד האזור, הוא ינובע מהכתובת. כדי לשפר את הביצועים, מומלץ לכלול את קוד האזור אם אתם יודעים אותו. אזורים לא עקביים או כפולים עלולים להוביל לביצועים ירודים. לדוגמה, אם השדה address_lines כבר כולל את האזור, אין לספק שוב את קוד האזור בשדה הזה. האזורים הנתמכים מפורטים בשאלות הנפוצות.
language_code

string

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

string

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

string

אופציונלי. קוד מיון נוסף, ספציפי למדינה. ברוב האזורים לא נעשה שימוש באפשרות הזו. במקרים שבהם הוא משמש, הערך הוא מחרוזת כמו 'CEDEX', אחריה יכול להופיע מספר (לדוגמה, 'CEDEX 7') או רק מספר, שמייצג את 'קוד התחום' (ג'מייקה), 'מחוון אזור המסירה' (מלווי) או 'מחוון סניף הדואר' (חוף השנהב).
administrative_area

string

אופציונלי. הרמה המנהלית הגבוהה ביותר שמשמשת לכתובות דואר של מדינה או אזור. לדוגמה, מדינה, מחוז, oblast או מחוז. בספרד, זהו המחוז ולא הקהילה האוטונומית (לדוגמה, 'Barcelona' ולא 'Catalonia'). במדינות רבות לא נהוג לציין אזור אדמיניסטרטיבי בכתובות. לדוגמה, בשווייץ, השדה הזה צריך להישאר ריק.
locality

string

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

string

אופציונלי. יישוב משנה של הכתובת. לדוגמה, יכול להיות שמדובר בשכונה, ברחוב או בעיר.
address_lines[]

string

חובה. שורות כתובת לא מובנות שמתארות את הרמות הנמוכות יותר של הכתובת.

מכיוון שלערכים בשדה address_lines אין פרטי סוג, ולפעמים הם מכילים כמה ערכים בשדה יחיד (למשל 'Austin, TX'), חשוב שהסדר של השורות יהיה ברור. סדר שורות הכתובת צריך להיות 'סדר מעטפה' עבור המדינה או האזור של הכתובת.

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

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

string

מומלץ להימנע מהגדרה של השדה הזה. בשלב הזה, לא נעשה בו שימוש ב-Address Validation API. בשלב זה, ה-API לא ידחה בקשות עם השדה הזה מוגדר, אבל המידע יושלך לפח ולא יוחזר בתגובה.
organization

string

מומלץ להימנע מהגדרה של השדה הזה. בשלב הזה, לא נעשה בו שימוש ב-Address Validation API. בשלב זה, ה-API לא ידחה בקשות עם השדה הזה מוגדר, אבל המידע יושלך לפח ולא יוחזר בתגובה.