Method: categories.list

تعرض قائمة بفئات الأنشطة التجارية. سيتطابق البحث مع اسم الفئة ولكن ليس معرّف الفئة.

يتطابق البحث فقط مع الجزء الأمامي من اسم الفئة (أي أنّ كلمة "طعام" قد تؤدي إلى عرض "قاعة طعام" ولكن ليس "مطعم وجبات سريعة").

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

معلمات طلب البحث

المَعلمات
regionCode

string

مطلوبة. تمثّل هذه السمة رمز البلد بصيغة ISO 3166-1 alpha-2.
languageCode

string

مطلوبة. تمثّل هذه السمة رمز اللغة BCP 47.
filter

string

اختياريّ. فلترة السلسلة من المستخدم. يُرجى العِلم أنّ الحقل الوحيد المتاح هو displayName. مثال: filter=displayName=foo
pageSize

integer

اختياريّ. عدد الفئات المطلوب جلبها لكل صفحة. الإعداد التلقائي هو 100 والحد الأدنى هو 1 والحد الأقصى لحجم الصفحة هو 100.
pageToken

string

اختياريّ. في حال تحديد ذلك، سيتم جلب الصفحة التالية من الفئات.
view

enum (CategoryView)

مطلوبة. تحدد الأجزاء إلى مورد الفئة التي يجب عرضها في الاستجابة.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

رسالة رد لـ BusinessCategories.ListCategories.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "categories": [
    {
      object (Category)
    }
  ],
  "nextPageToken": string
}
الحقول
categories[]

object (Category)

الفئات المطابقة استنادًا إلى المَعلمات المطلوبة
nextPageToken

string

إذا تجاوز عدد الفئات حجم الصفحة المطلوب، ستتم تعبئة هذا الحقل برمز مميّز لجلب الصفحة التالية من الفئات عند استدعاء لاحق إلى categories.list.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.