فهرستی از دسته های کسب و کار را برمی گرداند. جستجو با نام دسته مطابقت دارد اما با شناسه دسته مطابقت ندارد.
جستجو فقط با جلوی نام دسته مطابقت دارد (یعنی «غذا» ممکن است «فود کورت» را برگرداند اما نه «فست فود رستوران»).
درخواست HTTP
GET https://mybusinessbusinessinformation.googleapis.com/v1/categories
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
مولفه های | |
---|---|
regionCode | ضروری. کد کشور ISO 3166-1 آلفا-2. |
languageCode | ضروری. کد زبان BCP 47. |
filter | اختیاری. رشته فیلتر از کاربر. تنها فیلدی که پشتیبانی می شود |
pageSize | اختیاری. چند دسته برای واکشی در هر صفحه. پیش فرض 100، حداقل 1 و حداکثر اندازه صفحه 100 است. |
pageToken | اختیاری. در صورت مشخص شدن، صفحه بعدی دسته ها واکشی می شود. |
view | ضروری. مشخص می کند که کدام بخش از منبع Category باید در پاسخ بازگردانده شود. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
پیام پاسخ برای BusinessCategories.ListCategories.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"categories": [
{
object ( |
زمینه های | |
---|---|
categories[] | دسته های تطبیق بر اساس پارامترهای درخواستی. |
nextPageToken | اگر تعداد دستهها از اندازه صفحه درخواستی بیشتر باشد، این فیلد با نشانهای پر میشود تا صفحه بعدی دستهها را در تماس بعدی با |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/business.manage
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.