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

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

לדוגמה, במאפיין 'טיפוסים בני מנייה (enum)' 'Wi-Fi', המאפיין יכול להכיל את המילה 'בתשלום' (בתשלום) כדי לייצג Wi-Fi בתשלום.

שיטות

list

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