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"، يمكن أن تحتوي القيمة على "مدفوعة" لتمثيل خدمة Wi-Fi المدفوعة.

الطُرق

list

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