Method: attributes.list

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

طلب HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات طلب البحث

المعلمات
parent

string

اختيارية: اسم المورد للموقع الجغرافي من أجل البحث عن السمات المتاحة إذا تم ضبط هذا الحقل، لن تكون الحقول categoryName وregionCode وlanguageCode وshowAll مطلوبة ويجب عدم ضبطها.

التنسيق: locations/{locationId} (مثلاً: locations/1234567890).
categoryName

string

اختيارية: المعرّف الثابت للفئة الأساسية للعثور على السمات المتاحة يجب أن يكون بالتنسيق categories/{category_id} (مثلاً، categories/gcid:restaurant). هذا الحقل مطلوب إذا لم يتم ضبط parent وكانت قيمة showAll هي "خطأ".
regionCode

string

اختيارية: رمز البلد وفقًا لمعيار ISO 3166-1 alpha-2 للعثور على السمات المتاحة مطلوبة إذا لم يتم ضبط السمة parent.
languageCode

string

اختيارية: رمز BCP 47 للغة التي تريد الحصول على الأسماء المعروضة للسمات بها وإذا لم تكن هذه اللغة متاحة، سيتم تقديمها باللغة الإنجليزية.
showAll

boolean

اختيارية: في حال ضبطها على "صحيح"، يتم عرض البيانات الوصفية لجميع السمات المتاحة، مع تجاهل الحقلَين parent وcategoryName. يجب إدخال السمتَين languageCode وregionCode عند ضبط السمة showAll على "صحيح".
pageSize

integer

عدد السمات التي يجب تضمينها في كل صفحة القيمة التلقائية هي 200، والحد الأدنى هو 1.
pageToken

string

في حال تحديد هذه السمة، يتم استرداد الصفحة التالية من البيانات الوصفية للسمات.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

الردّ على AttributesService.ListAttributeMetadata.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
الحقول
attributeMetadata[]

object (AttributeMetadata)

مجموعة من البيانات الوصفية للسمات المتاحة
nextPageToken

string

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

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/business.manage

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.

AttributeMetadata

البيانات الوصفية لسمة معيّنة يحتوي على معلومات العرض الخاصة بالسمة، بما في ذلك الاسم المترجَم والعنوان لتجميع السمات ذات الصلة معًا.

تمثيل JSON 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
الحقول
parent

string

المعرّف الفريد للسمة
valueType

enum (AttributeValueType)

نوع القيمة للسمة يُفترض أن تكون القيم التي تم ضبطها واستردادها من هذا النوع.
displayName

string

الاسم المعروض المترجَم للسمة، إذا كان متاحًا، وإلا سيظهر الاسم المعروض باللغة الإنجليزية.
groupDisplayName

string

الاسم المعروض المترجَم للمجموعة التي تحتوي على هذه السمة، إذا كان متاحًا، وإلا سيظهر اسم المجموعة باللغة الإنجليزية. يتم جمع السمات ذات الصلة في مجموعة ويجب عرضها معًا تحت العنوان المحدّد هنا.
repeatable

boolean

إذا كانت القيمة "صحيح"، تتيح السمة استخدام قيم متعدّدة. إذا كانت القيمة "false"، يجب تقديم قيمة واحدة فقط.
valueMetadata[]

object (AttributeValueMetadata)

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

boolean

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

AttributeValueMetadata

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

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

value (Value format)

قيمة السمة
displayName

string

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

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