- בקשת HTTP
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- AttributeMetadata
- AttributeValueMetadata
מחזירה את רשימת המאפיינים שיהיו זמינים למיקום עם הקטגוריה הראשית והמדינה הנתונות.
בקשת HTTP
GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
parent |
שם המשאב של המיקום לחיפוש מאפיינים זמינים. אם השדה הזה מוגדר, categoryName, regionCode, languageCode ו-showAll אינם נדרשים ואין להגדיר אותם. |
categoryName |
המזהה היציב של הקטגוריה הראשית, כדי למצוא מאפיינים זמינים. חייב להיות מבין קטגוריות הפורמט/{category_id}. |
regionCode |
קוד מדינה לפי תקן ISO 3166-1 alpha-2 כדי למצוא מאפיינים זמינים. |
languageCode |
קוד השפה BCP 47 שבו צריך להזין את שמות התצוגה של המאפיינים. אם השפה הזו לא זמינה, המידע יסופק באנגלית. |
showAll |
המטא-נתונים של כל המאפיינים הזמינים מוחזרים כשהשדה הזה מוגדר כ-True, ומתעלמים מהשדות של הורה ו-categoryName. צריך להזין את languageCode ו-regionCode כשהערך של showAll מוגדר כ-true. |
pageSize |
כמה מאפיינים לכלול בכל דף. ברירת המחדל היא 200, המינימום הוא 1. |
pageToken |
אם צוין, הדף הבא של המטא-נתונים של המאפיין אוחזר. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
תגובה עבור AttributesService.ListAttributeMetadata.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"attributeMetadata": [
{
object ( |
שדות | |
---|---|
attributeMetadata[] |
אוסף של מטא-נתונים של מאפיינים עבור המאפיינים הזמינים. |
nextPageToken |
אם מספר המאפיינים חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון לאחזור דף המאפיינים הבא בקריאה הבאה אל |
היקפי הרשאות
נדרש היקף OAuth הבא:
https://www.googleapis.com/auth/business.manage
למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
AttributeMetadata
מטא-נתונים של מאפיין. מכילה מידע על התצוגה של המאפיין, כולל שם מותאם לשוק המקומי וכותרת לקיבוץ מאפיינים קשורים יחד.
ייצוג JSON |
---|
{ "parent": string, "valueType": enum ( |
שדות | |
---|---|
parent |
המזהה הייחודי של המאפיין. |
valueType |
סוג הערך של המאפיין. הערכים שמוגדרים ומאוחזרים אמורים להיות מהסוג הזה. |
displayName |
שם התצוגה המותאם לשוק המקומי של המאפיין, אם הוא זמין. אחרת, השם המוצג באנגלית. |
groupDisplayName |
שם התצוגה המותאם לשוק המקומי של הקבוצה שמכילה את המאפיין הזה, אם הוא זמין. אם לא, שם הקבוצה באנגלית. המאפיינים הקשורים נאספים בקבוצה, וצריך להציג אותם יחד מתחת לכותרת הנתונה כאן. |
repeatable |
אם הערך הוא True, המאפיין תומך במספר ערכים. אם False, יש לציין רק ערך אחד. |
valueMetadata[] |
בסוגים מסוימים של מאפיינים (לדוגמה, טיפוסים בני מנייה (enums)), מצורפת רשימה של ערכים נתמכים ושמות מוצגים שתואמים לערכים האלה. |
deprecated |
אם הערך הוא True, המאפיין הוצא משימוש ואסור להשתמש בו יותר. אם הוא הוצא משימוש, עדכון המאפיין לא יגרום לשגיאה, אבל העדכונים לא יישמרו. בשלב כלשהו אחרי ההוצאה משימוש, המאפיין יוסר לחלוטין והוא יהפוך לשגיאה. |
AttributeValueMetadata
מטא-נתונים של ערכי מאפיינים נתמכים.
ייצוג JSON |
---|
{ "value": value, "displayName": string } |
שדות | |
---|---|
value |
ערך המאפיין. |
displayName |
השם המוצג של הערך הזה, מותאם לשוק המקומי במקומות שבהם הוא זמין. אם לא, באנגלית. הערך המוצג מיועד לשימוש בהקשר של השם המוצג של המאפיין. לדוגמה, במאפיין 'טיפוסים בני מנייה (enum)' 'Wi-Fi', המאפיין יכול להכיל את המילה 'בתשלום' (בתשלום) כדי לייצג Wi-Fi בתשלום. |