- طلب 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 |
يتم عرض البيانات الوصفية لكل السمات المتاحة عند ضبط هذا الحقل على "صحيح"، مع تجاهل الحقلَين الرئيسيين و"اسم الفئة". يجب إدخال رمز اللغة ورمز المنطقة عند ضبط عرض الكل على "صحيح". |
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" enum، ويمكن أن تحتوي هذه القيمة على "مدفوع" لتمثيل شبكات Wi-Fi المدفوعة. |