Method: attributes.list

فهرستی از ویژگی‌هایی را که برای مکانی با دسته و کشور اصلی داده شده در دسترس است، برمی‌گرداند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
parent

string

نام منبع مکان برای جستجوی ویژگی های موجود. اگر این فیلد تنظیم شده باشد، دسته نام، ناحیه کد، languageCode و showAll مورد نیاز نیستند و نباید تنظیم شوند.

categoryName

string

شناسه پایدار دسته اصلی برای یافتن ویژگی‌های موجود. باید از دسته‌های قالب/{category_id} باشد.

regionCode

string

کد کشور ISO 3166-1 آلفا-2 برای یافتن ویژگی های موجود.

languageCode

string

کد زبان BCP 47 برای دریافت نام‌های نمایشی ویژگی‌ها. اگر این زبان در دسترس نباشد، آنها به زبان انگلیسی ارائه می‌شوند.

showAll

boolean

وقتی این فیلد روی درست تنظیم شود، بدون توجه به فیلدهای والد و CategoryName، متادیتا برای همه ویژگی‌های موجود برگردانده می‌شود. وقتی showAll روی true تنظیم شده باشد، languageCode و regionCode مورد نیاز است.

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 مراجعه کنید.

ویژگی Metadata

فراداده برای یک ویژگی حاوی اطلاعات نمایشی برای ویژگی، از جمله یک نام محلی و یک عنوان برای گروه بندی ویژگی های مرتبط با هم.

نمایندگی 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

اگر درست باشد، ویژگی از چندین مقدار پشتیبانی می کند. اگر نادرست است، فقط یک مقدار باید ارائه شود.

valueMetadata[]

object ( AttributeValueMetadata )

برای برخی از انواع ویژگی ها (به عنوان مثال، enums)، لیستی از مقادیر پشتیبانی شده و نام های نمایشی مربوط به آن مقادیر ارائه شده است.

deprecated

boolean

اگر درست باشد، این ویژگی منسوخ شده است و دیگر نباید استفاده شود. در صورت منسوخ شدن، به روز رسانی این ویژگی منجر به خطا نمی شود، اما به روز رسانی ها ذخیره نمی شوند. در نقطه ای پس از منسوخ شدن، ویژگی به طور کامل حذف می شود و به یک خطا تبدیل می شود.

AttributeValueMetadata

فراداده برای مقادیر ویژگی پشتیبانی شده.

نمایندگی JSON 
{
  "value": value,
  "displayName": string
}
فیلدها
value

value ( Value format)

مقدار ویژگی

displayName

string

نام نمایشی برای این مقدار، محلی سازی شده در صورت وجود؛ در غیر این صورت به زبان انگلیسی نام نمایشی مقدار در نظر گرفته شده است که در زمینه با نام نمایشی ویژگی استفاده شود.

به عنوان مثال، برای یک ویژگی enum "WiFi"، این می تواند حاوی "Paid" باشد تا Wi-Fi پولی را نشان دهد.