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

اگر درست باشد، ویژگی از چندین مقدار پشتیبانی می کند. اگر نادرست است، فقط یک مقدار باید ارائه شود.

valueMetadata[]

object ( AttributeValueMetadata )

برای برخی از انواع ویژگی ها (به عنوان مثال، enums)، لیستی از مقادیر پشتیبانی شده و نام های نمایشی مربوط به آن مقادیر ارائه شده است.

isDeprecated

boolean

اگر درست باشد، این ویژگی منسوخ شده است و دیگر نباید استفاده شود. در صورت منسوخ شدن، به روز رسانی این ویژگی منجر به خطا نمی شود، اما به روز رسانی ها ذخیره نمی شوند. در نقطه ای پس از منسوخ شدن، ویژگی به طور کامل حذف می شود و به یک خطا تبدیل می شود.

AttributeValueMetadata

فراداده برای مقادیر ویژگی پشتیبانی شده.

نمایندگی JSON 
{
  "value": value,
  "displayName": string
}
فیلدها
value

value ( Value format)

مقدار ویژگی

displayName

string

نام نمایشی برای این مقدار، محلی سازی شده در صورت وجود؛ در غیر این صورت به زبان انگلیسی نام نمایشی مقدار در نظر گرفته شده است که در زمینه با نام نمایشی ویژگی استفاده شود.

به عنوان مثال، برای یک ویژگی enum "WiFi"، این می تواند حاوی "Paid" باشد تا Wi-Fi پولی را نشان دهد.

روش ها

list

 فهرستی از ویژگی‌های موجود را که برای مکانی با دسته و کشور اصلی داده شده در دسترس است، برمی‌گرداند.