Method: attributes.list

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

درخواست HTTP

GET https://mybusiness.googleapis.com/v4/attributes

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

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

پارامترها
name

string

نام منبع مکان برای جستجوی ویژگی های موجود.

categoryId

string

شناسه پایدار دسته اصلی برای یافتن ویژگی‌های موجود.

country

string

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

languageCode

string

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

pageSize

integer

در هر صفحه چند ویژگی باید درج شود. پیش فرض 200 است، حداقل 1 است.

pageToken

string

اگر مشخص شده باشد، صفحه بعدی متادیتای ویژگی بازیابی می شود. pageToken زمانی برمی گردد که فراخوانی به attributes.list نتایج بیشتری را نسبت به اندازه صفحه درخواستی نشان دهد.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

پیام پاسخ برای Locations.ListAttributeMetadata.

نمایندگی JSON 
{
  "attributes": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
فیلدها
attributes[]

object ( AttributeMetadata )

مجموعه ای از فراداده های ویژگی برای ویژگی های موجود.

nextPageToken

string

اگر تعداد مشخصه‌ها از اندازه صفحه درخواستی بیشتر باشد، این فیلد با یک نشانه پر می‌شود تا صفحه بعدی ویژگی‌ها را در فراخوانی بعدی به attributes.list واکشی کند. اگر هیچ ویژگی دیگری وجود نداشته باشد، این فیلد در پاسخ وجود نخواهد داشت.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.