REST Resource: attributes

משאב: AttributeMetadata

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

ייצוג JSON 
{
  "attributeId": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "isRepeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "isDeprecated": boolean
}
שדות
attributeId

string

המזהה של המאפיין.
valueType

enum (AttributeValueType)

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

string

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

string

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

boolean

אם True, המאפיין תומך בכמה ערכים. אם False, יש לציין רק ערך אחד.
valueMetadata[]

object (AttributeValueMetadata)

לסוגים מסוימים של מאפיינים (לדוגמה, enums) מוצגת רשימה של ערכים נתמכים ושמות מוצגים שתואמים לערכים האלה.
isDeprecated

boolean

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

AttributeValueMetadata

מטא-נתונים של ערכי מאפיינים נתמכים.

ייצוג JSON 
{
  "value": value,
  "displayName": string
}
שדות
value

value (Value format)

ערך המאפיין.
displayName

string

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

לדוגמה, עבור רשת Wi-Fi מאפיין enum, יכול להכיל את הערך 'שולם' כדי לייצג Wi-Fi בתשלום.

שיטות

list

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