- طلب HTTP
- معامِلات طلب البحث
- نص الطلب
- نص الاستجابة
- نطاقات التفويض
- AttributeMetadata
- AttributeValueMetadata
تعرض قائمة السمات التي ستكون متاحة لموقع جغرافي يتضمّن الفئة الأساسية والبلد المحدّدَين.
طلب HTTP
GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
معلمات طلب البحث
المَعلمات | |
---|---|
parent |
اسم مورد الموقع الجغرافي للبحث عن السمات المتاحة في حال ضبط هذا الحقل، لن تكون الفئة "categoryName" و"regionCode" و"languageCode" و"showAll" مطلوبة، ويجب عدم ضبطها. |
categoryName |
المعرّف الثابت للفئة الأساسية للعثور على السمات المتاحة. يجب أن يكون بالصيغة الفئات/{category_id}. |
regionCode |
رمز البلد بصيغة ISO 3166-1 alpha-2 للبحث عن السمات المتاحة. |
languageCode |
رمز اللغة BCP 47 للحصول على أسماء عرض السمات. إذا لم تكن هذه اللغة متاحة، سيتم توفيرها باللغة الإنجليزية. |
showAll |
يتم عرض البيانات الوصفية لجميع السمات المتاحة عندما يتم تعيين هذا الحقل على "صحيح"، مع تجاهل الحقلين الأصل وcategoryName. ويكون رمز اللغة وكود المنطقة مطلوبين عند تعيين showAll على "true". |
pageSize |
عدد السمات المطلوب تضمينها في كل صفحة القيمة التلقائية هي 200، والحد الأدنى هو 1. |
pageToken |
في حال تحديد هذه السمة، يتم استرداد الصفحة التالية من البيانات الوصفية للسمة. |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
استجابة لـ AttributesService.ListAttributeMetadata.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"attributeMetadata": [
{
object ( |
الحقول | |
---|---|
attributeMetadata[] |
مجموعة من البيانات الوصفية للسمات المتاحة. |
nextPageToken |
إذا تجاوز عدد السمات حجم الصفحة المطلوب، ستتم تعبئة هذا الحقل برمز مميّز لجلب الصفحة التالية من السمات عند طلب لاحق إلى |
نطاقات التفويض
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/business.manage
لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.
AttributeMetadata
البيانات الوصفية لسمة معيّنة. تحتوي على معلومات معروضة للسمة، بما في ذلك الاسم المُترجَم وعنوان لتجميع السمات ذات الصلة معًا.
تمثيل JSON |
---|
{ "parent": string, "valueType": enum ( |
الحقول | |
---|---|
parent |
المعرّف الفريد للسمة. |
valueType |
نوع القيمة للسمة. يجب أن تكون القيم التي تم ضبطها واستردادها من هذا النوع. |
displayName |
الاسم المعروض المترجَم للسمة (إذا كان متاحًا)، وإلّا الاسم المعروض باللغة الإنجليزية. |
groupDisplayName |
الاسم المعروض المترجَم للمجموعة التي تحتوي على هذه السمة، إن توفَّر، وبخلاف ذلك، يتم استخدام اسم المجموعة باللغة الإنجليزية. يتم جمع السمات ذات الصلة في مجموعة ويجب عرضها معًا تحت العنوان المذكور هنا. |
repeatable |
إذا كانت القيمة true، تتيح السمة قيمًا متعددة. في حال اختيار القيمة "false"، يجب تقديم قيمة واحدة فقط. |
valueMetadata[] |
بالنسبة إلى بعض أنواع السمات (مثل التعدادات)، يتم تقديم قائمة بالقيم المسموح بها والأسماء المعروضة المقابلة لها. |
deprecated |
إذا كانت القيمة true، سيتم إيقاف السمة نهائيًا ويجب عدم استخدامها بعد ذلك. لن يؤدي تعديل هذه السمة إلى حدوث خطأ ولكن لن يتم حفظ التعديلات إذا تم إيقافها. في مرحلة معيّنة بعد إيقافها، ستتم إزالة السمة بالكامل وستتحوّل إلى خطأ. |
AttributeValueMetadata
البيانات الوصفية لقيم السمات المتوافقة
تمثيل JSON |
---|
{ "value": value, "displayName": string } |
الحقول | |
---|---|
value |
تمثّل هذه السمة قيمة السمة. |
displayName |
الاسم المعروض لهذه القيمة، مترجمة إذا كان متاحًا، وإلا، باللغة الإنجليزية. من المفترض أن يُستخدم الاسم المعروض للقيمة مع اسم السمة المعروض. على سبيل المثال، بالنسبة إلى سمة تعداد "WiFi"، يمكن أن تحتوي القيمة على "مدفوعة" لتمثيل خدمة Wi-Fi المدفوعة. |