Method: categories.list

فهرستی از دسته های کسب و کار را برمی گرداند. جستجو با نام دسته مطابقت دارد اما با شناسه دسته مطابقت ندارد.

درخواست HTTP

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

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

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

پارامترها
regionCode

string

کد کشور ISO 3166-1 آلفا-2.

languageCode

string

کد زبان BCP 47. اگر زبان در دسترس نباشد، به طور پیش فرض به انگلیسی خواهد بود.

searchTerm

string

رشته فیلتر اختیاری از کاربر.

pageSize

integer

چند دسته برای واکشی در هر صفحه. پیش فرض 100، حداقل 1 و حداکثر اندازه صفحه 100 است.

pageToken

string

در صورت مشخص شدن، صفحه بعدی دسته ها واکشی می شود.

view

enum ( CategoryView )

اختیاری. مشخص می کند که کدام بخش از منبع Category باید در پاسخ بازگردانده شود.

درخواست بدن

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

بدن پاسخگو

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

نمایندگی JSON 
{
  "categories": [
    {
      object (Category)
    }
  ],
  "totalCategoryCount": integer,
  "nextPageToken": string
}
فیلدها
categories[]

object ( Category )

دسته ها دسته ها نمای BASIC هستند. آنها حاوی هیچ گونه اطلاعات ServiceType نیستند.

totalCategoryCount

integer

تعداد کل دسته ها برای پارامترهای درخواست.

nextPageToken

string

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

محدوده مجوز

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

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

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