Package google.maps.mapmanagement.v2

אינדקס

מפת ממשק ניהול

הגדרת השירות של Map Management API.

Methods
CreateMapConfig יצירת MapConfig בפרויקט.
CreateMapContextConfig יוצר MapContextConfig.
CreateStyleConfig יוצר StyleConfig.
DeleteMapConfig מחיקת MapConfig.
DeleteMapContextConfig מחיקת MapContextConfig.
DeleteStyleConfig מחיקת StyleConfig.
GetMapConfig קבלת MapConfig.
GetMapContextConfig מקבלים MapContextConfig.
GetStyleConfig מקבל StyleConfig.
ListMapConfigs הצגת רשימה של MapConfigs בפרויקט.
ListMapContextConfigs הצגת רשימה של MapContextConfigs.
ListStyleConfigs הצגת רשימה של StyleConfigs.
UpdateMapConfig עדכון של MapConfig.
UpdateMapContextConfig מעדכן MapContextConfig.
UpdateStyleConfig מעדכן StyleConfig.

CreateMapConfigRequest

בקשה ליצירת MapConfig.

שדות
parent

string

חובה. פרויקט האב שיהיה הבעלים של MapConfig. פורמט: projects/{project}
map_config

MapConfig

חובה. ה-MapConfig שרוצים ליצור.

CreateMapContextConfigRequest

בקשה ליצירת MapContextConfig.

שדות
parent

string

חובה. ‫MapConfig אב שיחזיק ב-MapContextConfig. פורמט: projects/{project}/mapConfigs/{map_config}
map_context_config

MapContextConfig

חובה. ה-MapContextConfig שרוצים ליצור.

CreateStyleConfigRequest

בקשה ליצירת StyleConfig.

שדות
parent

string

חובה. הפרויקט הראשי שיהיה הבעלים של StyleConfig. פורמט: projects/{project}
style_config

StyleConfig

חובה. ה-StyleConfig שרוצים ליצור.

DeleteMapConfigRequest

בקשה למחיקה של MapConfig.

שדות
name

string

חובה. השם של MapConfig שרוצים למחוק. פורמט: projects/{project}/mapConfigs/{map_config}

DeleteMapContextConfigRequest

בקשה למחיקה של MapContextConfig.

שדות
name

string

חובה. השם של MapContextConfig שרוצים למחוק. פורמט: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

DeleteStyleConfigRequest

בקשה למחיקה של StyleConfig.

שדות
name

string

חובה. השם של StyleConfig שרוצים למחוק. פורמט: projects/{project}/styleConfigs/{style_config}

GetMapConfigRequest

בקשה לקבל MapConfig.

שדות
name

string

חובה. השם של MapConfig לאחזור. פורמט: projects/{project}/mapConfigs/{map_config}

GetMapContextConfigRequest

בקשה לקבלת MapContextConfig.

שדות
name

string

חובה. השם של MapContextConfig לאחזור. פורמט: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

GetStyleConfigRequest

בקשה לקבל StyleConfig.

שדות
name

string

חובה. השם של StyleConfig לאחזור. פורמט: projects/{project}/styleConfigs/{style_config}
view

StyleConfigView

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

ListMapConfigsRequest

בקשה להצגת רשימה של MapConfigs לפרויקט.

שדות
parent

string

חובה. פרויקט האב שבבעלותו נמצאים אובייקטי MapConfigs. פורמט: projects/{project}
page_size

int32

אופציונלי. מספר ה-MapConfigs המקסימלי שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, יוחזרו לכל היותר 50 MapConfigs. הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000. לא נתמך כרגע.
page_token

string

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

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

ListMapConfigsResponse

תשובה לרשימת MapConfigs.

שדות
map_configs[]

MapConfig

רשימת MapConfigs.
next_page_token

string

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

ListMapContextConfigsRequest

בקשה להצגת רשימה של MapContextConfigs.

שדות
parent

string

חובה. קובץ MapConfig של ההורה שבבעלותו קובצי MapContextConfig. פורמט: projects/{project}/mapConfigs/{map_config}
page_size

int32

אופציונלי. המספר המקסימלי של MapContextConfigs שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, יוחזרו לכל היותר 50 אובייקטים של MapContextConfig. הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000. לא נתמך כרגע.
page_token

string

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

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

ListMapContextConfigsResponse

תשובה לרשימה MapContextConfigs.

שדות
map_context_configs[]

MapContextConfig

‫MapContextConfigs.
next_page_token

string

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

ListStyleConfigsRequest

בקשה להצגת רשימה של StyleConfigs.

שדות
parent

string

חובה. הפרויקט הראשי שבבעלותו StyleConfigs. פורמט: projects/{project}
page_size

int32

אופציונלי. המספר המקסימלי של StyleConfigs שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, יוחזרו לכל היותר 50 StyleConfigs. הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000. לא נתמך כרגע.
page_token

string

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

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

string

אופציונלי. ביטוי סינון לקריאה ListStyleConfigs. בשלב הזה יש תמיכה רק בסינון לפי display_name. לדוגמה: display_name="My StyleConfig" יחזיר את כל StyleConfigs עם השם המוצג My StyleConfig.
view

StyleConfigView

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

ListStyleConfigsResponse

תשובה לרשימה של StyleConfigs.

שדות
style_configs[]

StyleConfig

‫StyleConfigs.
next_page_token

string

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

MapConfig

מייצג מפה יחידה באפליקציית לקוח של Maps API. ‫MapConfig הוא משאב האב של MapContextConfigs ומאפשר עיצוב בהתאמה אישית בערכות SDK לנייד ולאינטרנט. ל-MapConfig יכולים להיות כמה MapContextConfigs, שכל אחד מהם מחיל סגנון על וריאציות ספציפיות של המפה. המזהה הבא = 9;

שדות
name

string

פלט בלבד. מזהה. שם המשאב של MapConfig הזה. לדוגמה: projects/my-project-123/mapConfigs/234.
display_name

string

אופציונלי. השם לתצוגה של MapConfig הזה, כפי שהוגדר על ידי המשתמש.
description

string

אופציונלי. התיאור של MapConfig, כפי שהוגדר על ידי המשתמש.
map_id

string

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

MapFeatures

אופציונלי. תכונות המפה שחלות על הגדרת המפה הזו.
map_type

MapRenderingType

אופציונלי. מייצג את סוג המפה של MapConfig. אם לא מגדירים את המאפיין הזה, ברירת המחדל היא שימוש בסוג מפת רסטר.
create_time

Timestamp

פלט בלבד. מציין את זמן היצירה של הגדרות המפה.
update_time

Timestamp

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

MapContextConfig

מכיל את הגדרות הסגנון של המפה. ה-MapContextConfig משייך רכיבי סגנון, כמו StyleConfig ו-Datasets, לגרסאות ספציפיות של מפה ב-MapConfig. כש-MapConfig נטען ב-SDK, סגנון העיצוב ופרטי מערך הנתונים מ-MapContextConfig מוחלים על וריאציות המפה שצוינו. המזהה הבא = 10;

שדות
name

string

פלט בלבד. מזהה. שם המשאב של MapContextConfig הזה. לדוגמה: projects/{project_id}/mapConfigs/{map_id}/mapContextConfigs/{map_context_config_id}
map_config

string

חובה. שם המשאב MapConfig שאליו משויך MapContextConfig. פורמט: projects/{project}/mapConfigs/{map_config}. חובה למלא את השדה הזה.
style_config

string

חובה. שם המשאב StyleConfig שמשמש לעיצוב של MapContextConfig. חובה למלא את השדה הזה. פורמט: projects/{project}/styleConfigs/{style_config}
dataset[]

string

אופציונלי. שם המשאב של מערך הנתונים שמשויך ל-MapContextConfig הזה. השדה הזה הוא אופציונלי ואפשר להשמיט אותו. אם לא מציינים מערכי נתונים, לא ישויכו מערכי נתונים ל-MapContextConfig. אם מציינים מערך נתונים, הוא יוחל על MapContextConfig. פורמט: projects/{project}/datasets/{dataset}
alias

string

אופציונלי. השם שמוגדר על ידי המשתמש, שקריא לבני אדם, של MapContextConfig.
map_variants[]

MapVariant

חובה. הווריאציות של המפה שאפשר להחיל עליהן את MapContextConfig. אם הערך ריק, MapContextConfig יוחל כברירת מחדל רק על וריאציית המפה ROADMAP.
create_time

Timestamp

פלט בלבד. מציין את זמן היצירה של MapContextConfig.
update_time

Timestamp

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

MapVariant

וריאציות אפשריות של מפות שאפשר להחיל עליהן את MapContextConfig. וריאציות של מפות מחולקות לקבוצות של וריאציות בהירות וכהות. אי אפשר לשייך וריאציה מסוג Light לווריאציה מסוג Dark באותו MapContextConfig. הווריאציות של התאורה הן: תוכנית דרכים, תמונת לוויין, טופוגרפיה, ניווט, תחבורה ציבורית, תלת-ממד מופשט ותלת-ממד פוטוריאליסטי. הווריאציות הכהות הן: ROADMAP_DARK, ‏ NAVIGATION_LOW_LIGHT, ‏ TERRAIN_DARK, ‏ TRANSIT_DARK.

לדוגמה, זאת התאמה תקפה: {MapContextConfig 1: [ROADMAP, NAVIGATION]} {MapContextConfig 2: [ROADMAP_DARK, NAVIGATION_LOW_LIGHT]}

ההתאמה הבאה לא תקינה: {MapContextConfig 1: [ROADMAP, ROADMAP_DARK]}

טיפוסים בני מנייה (enum)
ROADMAP סוג המפה שמוגדר כברירת מחדל במפת הדרכים.
ROADMAP_DARK גרסה כהה של סוג המפה 'מפת דרכים'.
SATELLITE תמונות לוויין.
TERRAIN סוג מפת פני השטח.
TERRAIN_DARK גרסה כהה של סוג מפת פני השטח.
NAVIGATION סוג מפת הניווט.
NAVIGATION_LOW_LIGHT גרסה של סוג מפת הניווט לתנאי תאורה חלשה.
TRANSIT סוג מפת התחבורה הציבורית.
TRANSIT_DARK גרסה כהה של סוג מפת התחבורה הציבורית.
ABSTRACT3D סוג מפה תלת-ממדית מופשטת.
PHOTOREALISTIC3D סוג מפה ריאליסטית בתלת-ממד.

MapFeatures

מייצג אוסף של תכונות מפה שחלות על MapConfig. תכונות שמוגדרות ב-MapConfig עוברות בירושה לכל רכיבי MapContextConfig הצאצאים שלו. המזהה הבא = 3;

שדות
simple_features[]

SimpleFeature

אופציונלי. התכונה החזותית שבה רוצים להשתמש במפה הזו.
poi_boost_level

int32

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

SimpleFeature

הקבוצה הזו מייצגת את התכונות של המפה שמשפיעות על המבנה הפנימי שלה.

טיפוסים בני מנייה (enum)
SIMPLE_FEATURE_UNSPECIFIED תכונה חזותית לא מוגדרת.
FLATTEN_BUILDINGS הופך את כל המבנים במפה לדו-ממדיים.
ICONIC_ICONS משפיע על אופן העיבוד של הסמלים.

MapRenderingType

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

טיפוסים בני מנייה (enum)
RASTER מפה שעברה עיבוד באמצעות ההטמעה שמבוססת על רסטר.
VECTOR מפה שעברה רינדור באמצעות WebGL.

StyleConfig

מייצג סגנון יחיד באפליקציית לקוח של Maps API. האובייקט StyleConfig מכיל את גיליון הסגנונות שמגדיר את המראה החזותי של המפה. המזהה הבא = 9;

שדות
name

string

פלט בלבד. מזהה. שם המשאב של StyleConfig הזה. לדוגמה: projects/my-project-123/styleConfigs/234.
display_name

string

אופציונלי. השם המוצג של StyleConfig, כפי שהוגדר על ידי המשתמש.
description

string

אופציונלי. התיאור של StyleConfig הזה, כפי שצוין על ידי המשתמש.
style_id

string

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

string

אופציונלי. ייצוג JSON של גיליון הסגנונות של StyleConfig הזה. אם לא מציינים סגנון, המערכת תשתמש בסגנון הבסיסי של מפת Google. מידע נוסף על פורמט JSON הקביל זמין בכתובת https://developers.google.com/maps/documentation/javascript/cloud-customization/json-reference.
create_time

Timestamp

פלט בלבד. מציין את זמן היצירה של StyleConfig.
update_time

Timestamp

פלט בלבד. מציין את זמן העדכון האחרון של StyleConfig.

StyleConfigView

איזה קבוצת משנה של StyleConfig להחזיר.

טיפוסים בני מנייה (enum)
STYLE_CONFIG_VIEW_UNSPECIFIED תצוגה לא מזוהה.
FULL כוללים את json_style_sheet בתשובה.
METADATA_ONLY החרגת ה-json_style_sheet מהתשובה.

UpdateMapConfigRequest

שליחת בקשה לעדכון של MapConfig.

שדות
map_config

MapConfig

חובה. ה-MapConfig לעדכון.

השדה name של MapConfig משמש לזיהוי של MapConfig שצריך לעדכן. פורמט: projects/{project}/mapConfigs/{map_config}
update_mask

FieldMask

אופציונלי. השדה הספציפי לעדכון ב-MapConfig. אם לא מציינים, המערכת תעדכן את MapConfig בשלמותו. השדות התקינים הם:

  • display_name
  • description
  • map_features

UpdateMapContextConfigRequest

בקשה לעדכן MapContextConfig.

שדות
map_context_config

MapContextConfig

חובה. ה-MapContextConfig לעדכון.

השדה name של MapContextConfig משמש לזיהוי MapContextConfig לעדכון. פורמט: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}
update_mask

FieldMask

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

  • display_name
  • alias
  • map_variants
  • style_config
  • dataset

UpdateStyleConfigRequest

בקשה לעדכון של StyleConfig.

שדות
style_config

StyleConfig

חובה. ה-StyleConfig לעדכון.

השדה name של StyleConfig משמש לזיהוי ה-StyleConfig שרוצים לעדכן. פורמט: projects/{project}/styleConfigs/{style_config}
update_mask

FieldMask

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

  • display_name
  • description
  • json_style_sheet