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)

بالنسبة إلى بعض أنواع السمات (مثل التعداد)، يتم تقديم قائمة بالقيم المسموح بها والأسماء المعروضة المقابلة لهذه القيم.

isDeprecated

boolean

إذا كانت القيمة هي true، سيتم إيقاف السمة نهائيًا ويجب عدم استخدامها بعد ذلك. إذا تم إيقافها، لن يؤدي تعديل هذه السمة إلى حدوث خطأ، ولكن لن يتم حفظ التعديلات. في مرحلة ما بعد إيقافها، ستتم إزالة السمة بالكامل وستصبح خطأً.

AttributeValueMetadata

البيانات الوصفية لقيم السمات المسموح بها

تمثيل JSON
{
  "value": value,
  "displayName": string
}
الحقول
value

value (Value format)

قيمة السمة.

displayName

string

الاسم المعروض لهذه القيمة، بما يناسب السوق المحلية حيثما كان ذلك متاحًا أو باللغة الإنجليزية. تم تصميم القيمة "الاسم المعروض" لاستخدامها مع السياق مع الاسم المعروض للسمة.

على سبيل المثال، بالنسبة إلى "WiFi" enum، ويمكن أن تحتوي هذه القيمة على "مدفوع" لتمثيل شبكات Wi-Fi المدفوعة.

الطُرق

list

تعرض قائمة السمات المتاحة التي قد تكون متاحة لموقع جغرافي يتضمن الفئة الأساسية والبلد المحدّدَين.